From cc0d8203f690f2485ecbdff5cb8e02d95c567fec Mon Sep 17 00:00:00 2001 From: Ryan Watters Date: Fri, 10 Mar 2017 03:19:27 -0600 Subject: [PATCH] Update docs contrib guide --- archetypes/showcase.md | 4 ++-- archetypes/tutorials.md | 2 +- content/contribute/documentation.md | 10 +++++----- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/archetypes/showcase.md b/archetypes/showcase.md index 750a5fba3..562fb9e8e 100644 --- a/archetypes/showcase.md +++ b/archetypes/showcase.md @@ -7,7 +7,7 @@ sitelink: "" sourcelink: "" categories: [showcase] tags: [] -image: "yourimage.jpg" +image: "" toc: false -z_notesforauthors: "Go to gohugo.io/contribute/documentation for more info on using this archetype." +notesforauthors: "Go to gohugo.io/contribute/documentation for more info" --- \ No newline at end of file diff --git a/archetypes/tutorials.md b/archetypes/tutorials.md index 5c08f5df0..0a3540c0f 100644 --- a/archetypes/tutorials.md +++ b/archetypes/tutorials.md @@ -11,6 +11,6 @@ authorurl: "" originalurl: "" draft: false aliases: [] -z_notesforauthors: "Go to gohugo.io/contribute/documentation for more info on using this archetype." +notesforauthors: "Go to gohugo.io/contribute/documentation for more info." --- diff --git a/content/contribute/documentation.md b/content/contribute/documentation.md index 2c1d43751..9493c75db 100644 --- a/content/contribute/documentation.md +++ b/content/contribute/documentation.md @@ -109,23 +109,23 @@ The archetype for the `showcase` content type is as follows: #### Showcase Required Fields -`sitelink` +***`sitelink`*** : the *full* URL to your website. -`title` +***`title`*** : the `` of your website. -`description` +***`description`*** : a general description of your website, preferably < 180 characters. -`image` +***`image`*** : the image (filename only) you want to associate with your website on the Showcase page. The image should be 450px × 300px. We also appreciate the addition of the remaining fields, especially `sourcelink` and `license` if you are willing to share your hard work with the open-source community. `tags` is optional, but we recommend adding at least 2 to 3 tags to improve discoverability. #### Add an Image for the Showcase -We need to create the thumbnail of your website. Give your thumbnail a name like `my-hugo-site-name.jpg`. Save it under [`docs/static/images/showcase/`][]. +Youl will need to create a thumbnail of your website. Give your thumbnail a name like `my-hugo-site-name.jpg`. Save it under [`docs/static/images/showcase/`][]. {{% warning "Showcase Image Size" %}} It's important that the image you use for your showcase submission has the required dimensions of 450px × 300px or the site will not render appropriately. Be sure to optimize your image as a matter of best practice. [Compressor](https://compressor.io/) offers a simple drag-and-drop GUI for optimizing your images. JPEGs are typically smaller in size than are PNGs.