Fix dialogs (#25)

* add view all links

* Finish updating all dialogs

* fancy images

Author: osterman

Makefile

@@ -1,5 +1,6 @@
 export INSTALL_PATH ?= /usr/local/bin
 export HUGO ?= hugo
+export HUGO_VERSION ?= 0.40.2
 export HUGO_URL ?= http://localhost.cloudposse.com:1313/
 export HUGO_ARGS ?= --watch --buildDrafts
 export PACKAGES_VERSION ?= 0.1.7

config.toml

@@ -46,46 +46,46 @@ home = [ "HTML", "RSS", "JSON"]
 
 [[menu.shortcuts]]
 pre = "<h3>More</h3>"
-name = "<i class='fa fa-github'></i> <label>Documentation</label>"
+name = "<i class='fa fa-book'></i> <label>Documentation</label>"
 identifier = "documentation"
 url = "/"
 weight = 10
 
 [[menu.shortcuts]]
-pre = "<h3>More</h3>"
-name = "<i class='fa fa-github'></i> <label>Support</label>"
-identifier = "support"
-url = "https://github.com/cloudposse/docs/issues"
+name = "<i class='fa fa-bullhorn'></i> <label>Announcements</label>"
+identifier = "announcements"
+url = "/announcements/"
 weight = 20
 
-[[menu.shortcuts]]
-pre = "<h3>More</h3>"
-name = "<i class='fa fa-github'></i> <label>Ask a Question</label>"
-identifier = "ask-a-question"
-url = "https://github.com/cloudposse/docs/issues/new"
-weight = 30
-
 [[menu.shortcuts]]
 pre = "<h3>More</h3>"
 name = "<i class='fa fa-github'></i> <label>Our GitHub</label>"
 identifier = "github"
 url = "https://github.com/cloudposse/"
+weight = 30
+
+[[menu.shortcuts]]
+name = "<i class='fa fa-bookmark'></i> <label>Blog</label>"
+identifier = "blog"
+url = "https://cloudposse.com/blog/"
 weight = 40
 
 [[menu.shortcuts]]
-name = "<i class='fa fa-cloud-download'></i> <label>Announcements</label>"
-identifier = "announcements"
-url = "/announcements/"
+pre = "<h3>More</h3>"
+name = "<i class='fa fa-question'></i> <label>Support</label>"
+identifier = "support"
+url = "https://github.com/cloudposse/docs/issues"
 weight = 50
 
 [[menu.shortcuts]]
-name = "<i class='fa fa-bookmark'></i> <label>Blog</label>"
-identifier = "blog"
-url = "https://cloudposse.com/blog/"
+pre = "<h3>More</h3>"
+name = "<i class='fa fa-edit'></i> <label>Ask a Question</label>"
+identifier = "ask-a-question"
+url = "https://github.com/cloudposse/docs/issues/new"
 weight = 60
 
 [[menu.shortcuts]]
-name = "<i class='fa fa-bullhorn'></i> <label>Contact Us</label>"
+name = "<i class='fa fa-envelope'></i> <label>Contact Us</label>"
 url = "/documentation/contact-us/"
 identifier = "contact-us"
 weight = 70

content/announcements/_index.mb

@@ -1,5 +1,7 @@
 ---
 title: "Announcements"
+icon: "fa fa-bullhorn"
+head: "dude"
 ---
 Welcome to the developer hub and documentation for Cloud Posse! Here you'll find announcements pertaining to new projects, terraform modules, helm charts, and other offerings.
 

content/aws/_index.md

@@ -1,6 +1,7 @@
 ---
 title: AWS Infrastructure
 slug: "aws"
+icon: "fab fa-aws"
 excerpt: ''
 ---
 

content/contributors/_index.md

@@ -1,7 +1,8 @@
 ---
 title: "Contributors"
 excerpt: ""
+icon: "fa fa-users"
 ---
-{{% dialog type="info" icon="fa-info-circle" title="People" %}}
+{{% dialog type="info" icon="fa fa-info-circle" title="People" %}}
 ⇠ Select one of the contributors on the left to learn more about them.
 {{% /dialog %}}

content/development/_index.md

@@ -1,7 +1,8 @@
 ---
 title: "Development"
 excerpt: ""
+icon: "fa fa-code"
 ---
-{{% dialog type="info" icon="fa-info-circle" title="Read More" %}}
+{{% dialog type="info" icon="fa fa-book" title="Read More" %}}
 ⇠ Select one of these pages to learn more about the topic.
 {{% /dialog %}}

content/development/github/_index.md

@@ -2,6 +2,6 @@
 title: "GitHub"
 excerpt: ""
 ---
-{{% dialog type="info" icon="fa-info-circle" title="Read More" %}}
+{{% dialog type="info" icon="fa fa-book" title="Read More" %}}
 ⇠ Select one of the pages to learn more about the topic.
 {{% /dialog %}}

content/development/github/feature-branches.md

@@ -21,17 +21,20 @@ The next thing that needs to happen is that the `master` branch is treated as th
 
 Once a feature is considered ready, the developer submits a Pull Request (or PR) and assigns it to a Subject Matter Expert (SME) or peer for review.
 
-On the surface, this is what a well-formatted Pull Request looks like: ![Pull Request Example](/assets/e802ae2-image_3.png) A _Pull Request_ allows many things to happen:
+On the surface, this is what a well-formatted Pull Request looks like: {{< img src="/assets/e802ae2-image_3.png" title="Example Pull Request" >}}
 
-- **Title**: A "human readable" title that represents the feature! ![Pull Request Title](/assets/2d4fce9-image.png)
+
+A _Pull Request_ allows many things to happen:
+
+- **Title**: A "human readable" title that represents the feature! {{< img src="/assets/2d4fce9-image.png" title="Example Pull Request Title" >}}
 - **Description**: A long description that details **_What_** was changed, **_Why_** it was deemed necessary, and any other **_References_** that might be useful (E.g. Jira ticket)
 - **Comments**: let anyone provide arbitrary feedback viewable by everyone.
 - **Diffs**: show what changed between this feature and the current master branch
-- **Formal Code Review Process:** let multiple people contribute to the code review process by submitting comments on a line-by-line basis. Having these code reviews formally documented serves as an excellent teaching tool. Over time, the reviews become faster and faster as developers learn what is expected. ![](/assets/9df4fad-image_2.png)
-- **Merging**: Once the PR is approved, the developer can squash and merge their code into the master branch. Squashing allows the master branch to have a very clean commit history where every commit corresponds to a PR. ![](/assets/2b3e7eb-image_4.png)
-- **Clean Commit History**: means that every change to the master branch is documented and justified. No one is sneaking in changes. ![Clean Commit History](/assets/b3dae79-image_5.png)
-- **History of Features** and when they were added ![History of Features](/assets/f9a3727-image_7.png)
-- **Reverting**: If a feature needs to be removed, with the click of a single button it can be removed from the `master` branch ![Reverting Changes](/assets/28887e9-image_8.png)
+- **Formal Code Review Process:** let multiple people contribute to the code review process by submitting comments on a line-by-line basis. Having these code reviews formally documented serves as an excellent teaching tool. Over time, the reviews become faster and faster as developers learn what is expected. {{< img src="/assets/9df4fad-image_2.png" title="Example of Code Review" >}}
+- **Merging**: Once the PR is approved, the developer can squash and merge their code into the master branch. Squashing allows the master branch to have a very clean commit history where every commit corresponds to a PR. {{< img src="/assets/2b3e7eb-image_4.png" title="Example of Merging" >}}
+- **Clean Commit History**: means that every change to the master branch is documented and justified. No one is sneaking in changes. {{< img src="/assets/b3dae79-image_5.png" title="Example of Clean Commit History" >}}
+- **History of Features** and when they were added {{< img src="/assets/f9a3727-image_7.png" title="History of Features" >}}
+- **Reverting**: If a feature needs to be removed, with the click of a single button it can be removed from the `master` branch {{< img src="/assets/28887e9-image_8.png" title="Example of Reverting Changes" >}}
 
   # Technical Details
 

content/development/github/pull-requests.md

@@ -44,4 +44,6 @@ Use the following markdown template to describe the Pull Request.
 
 **Pro Tip:** Use a `.github/pull_request_template.md` file to automatically populate this template when creating new Pull Requests.
 
-Read more: <https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/>
+{{% dialog type="info" icon="fa fa-book" title="Read More" %}}
+<https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/>
+{{% /dialog %}}

content/development/markdown/best-practices.md

@@ -7,19 +7,19 @@ excerpt: ''
 
 Using Markdown is essential for clear communication on mediums such as GitHub, Slack or just plain text. Here are some of our recommendations on when to use certain conventions.
 
-{{% dialog type="info" icon="fa-info-circle" title="Markdown Cheatsheet" %}} If you're new to Markdown or need a refresher, check out our [Markdown cheatsheet](/development/markdown). {{% /dialog %}}
+{{% dialog type="info" icon="fa fa-info-circle" title="Markdown Cheatsheet" %}} If you're new to Markdown or need a refresher, check out our [Markdown cheatsheet](/development/markdown). {{% /dialog %}}
 
 # Code Blocks
 
 Use code blocks for anything more than 1 line. Use `code` for inline code, filenames, commands, etc.
 
 ## Code Block
 
-````markdown
+~~~~markdown
 ```
 # This is a code block
 ```
-`````
+~~~~
 
 
 ## Table of Options
@@ -30,23 +30,25 @@ Here's an example:
 
 ##### Table of Options
 ```markdown
-|  Name       |  Default |  Description                                  | Required |
-|:------------|:--------:|:----------------------------------------------|:--------:|
-| namespace   | ``       | Namespace (e.g. `cp` or `cloudposse`)         | Yes      |
-| stage       | ``       | Stage (e.g. `prod`, `dev`, `staging`)         | Yes      |
-| name        | ``       | Name  (e.g. `bastion` or `db`)                | Yes      |
-| attributes  | []       | Additional attributes (e.g. `policy`)         | No       |
-| tags        | {}       | Additional tags  (e.g. `map("Foo","XYZ")`)    | No       |
+| Name       | Default | Description                                | Required |
+|:---------- |:-------:|:------------------------------------------ |:--------:|
+| namespace  |         | Namespace (e.g. `cp` or `cloudposse`)      |   Yes    |
+| stage      |         | Stage (e.g. `prod`, `dev`, `staging`)      |   Yes    |
+| name       |         | Name  (e.g. `bastion` or `db`)             |   Yes    |
+| attributes |   []    | Additional attributes (e.g. `policy`)      |    No    |
+| tags       |   {}    | Additional tags  (e.g. `map("Foo","XYZ")`) |    No    |
+```
 
 * `:--------:` should be used for “Default” and “Required” values
 * `:---------` should be used for all other columns
-* Use `` for empty defaults
 * Use `value` for all values
 
 
-Which will render to something like this: ![](/assets/8d8cdf3-image_23.png)
+Which will render to something like this:
+
+{{< img src="/assets/8d8cdf3-image_23.png" title="Example Markdown Table Rendering" >}}
 
-![Example Markdown Table](/assets/a2761a9-image_22.png)
+{{< img src="/assets/a2761a9-image_22.png" title="Example Markdown Table Rendering" >}}
 
 # Feature List Formatting