Skip to content

Commit

Permalink
Fix dialogs (#25)
Browse files Browse the repository at this point in the history
* add view all links

* Finish updating all dialogs

* fancy images
  • Loading branch information
osterman authored May 9, 2018
1 parent c22c333 commit d3c5fad
Show file tree
Hide file tree
Showing 80 changed files with 467 additions and 298 deletions.
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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
Expand Down
38 changes: 19 additions & 19 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 2 additions & 0 deletions content/announcements/_index.mb
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
1 change: 1 addition & 0 deletions content/aws/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: AWS Infrastructure
slug: "aws"
icon: "fab fa-aws"
excerpt: ''
---

Expand Down
3 changes: 2 additions & 1 deletion content/contributors/_index.md
Original file line number Diff line number Diff line change
@@ -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 %}}
3 changes: 2 additions & 1 deletion content/development/_index.md
Original file line number Diff line number Diff line change
@@ -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 %}}
2 changes: 1 addition & 1 deletion content/development/github/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}}
17 changes: 10 additions & 7 deletions content/development/github/feature-branches.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 3 additions & 1 deletion content/development/github/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}}
28 changes: 15 additions & 13 deletions content/development/markdown/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down
1 change: 1 addition & 0 deletions content/devops-methodology/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "DevOps Methodology"
excerpt: ""
icon: "fa fa-terminal"
---
Cloud Posse is a **DevOps Professional Services** company. Everything we do is Open Source. [Hire us]({{< relref "documentation/contact-us.md" >}}) to help you implement it.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,41 +118,41 @@ Prior to rollout, all 3 production instances indicated high memory pressure (90%

### Pingom

![Pingdom 1](/assets/1f27db8-image_12.png)
{{< img src="/assets/1f27db8-image_12.png" title="Pingdom 1" >}}

![Pingdom 2](/assets/89c0050-image_13.png)
{{< img src="/assets/89c0050-image_13.png title="Pingdom 2" >}}

![Pingdom 3](/assets/9d3f441-image_14.png)
{{< img src="/assets/9d3f441-image_14.png title="Pingdom 1" >}}

### Elastic Beanstalk

ElasticBeanstalk saw a massive increase in requests which manifested as a Denial of Service Attack. This was triggered probably by mod_pagespeed generating pages for webp assets which could not be served by upgraded servers. Varnish does not cache 404s. ![](/assets/af54926-image_15.png)

![](/assets/dc4dbd3-image_16.png)
{{< img src="/assets/dc4dbd3-image_16.png" title="ElasticBeanstalk Request Spike" >}}

### RDS

There were no deadlocks. There was no increase in IOPS (r/w)

#### CPU Utilization spiked.

![CPU Utilization Spiked](/assets/2e1d7be-image_17.png)
{{< img src="/assets/2e1d7be-image_17.png)" title="CPU Utilization Spiked" >}}

#### Connections peaked and maxed out.

![DB Connections Peaked](/assets/8f2e7d3-image_18.png)
{{< img src="/assets/8f2e7d3-image_18.png" title="DB Connections Peaked" >}}

#### Selects went through the roof.

![DB Selects Spiked](/assets/43dfb04-image_19.png)
{{< img src="/assets/43dfb04-image_19.png" title="DB Selects Spiked" >}}

#### CPU credits were not exhausted, so we had excess capacity

![CPU Credits Okay](/assets/7bd6416-image_20.png)
{{< img src="/assets/7bd6416-image_20.png" title="CPU Credits Okay" >}}

#### Commits / Writes went through the roof

![DB Commits Spiked](/assets/b7a608c-image_21.png)
{{< img src="/assets/b7a608c-image_21.png" title="DB Commits Spiked" >}}

## Related Post Mortems

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,6 @@ This is a hybrid of two types: `Infrastructure as a Code` and `Deployable backin

`Backing Services` usually extends the functionality of kubernetes or provide some services for CI/CD and development (example: artifact storage / chartmuseum / external dns / tls certbot )

`Backing Services` stored in the same repo with `Infrastructure as a Code` software. So `Backing Services` does not have independent build, test and release steps. On deploy step `Backing Services` deploys independently from umbrella `Infrastructure as a Code` app. ![Backing Services Process loop](/assets/70b071a-Process_Loop_-_Backing_Services_-_Page_1.png)Backing Services Process loop
`Backing Services` stored in the same repo with `Infrastructure as a Code` software. So `Backing Services` does not have independent build, test and release steps. On deploy step `Backing Services` deploys independently from umbrella `Infrastructure as a Code` app.

{{< img src="/assets/70b071a-Process_Loop_-_Backing_Services_-_Page_1.png" title="Backing Services Process loop" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@ excerpt: ''

*Deployable application* - is the software that can be deployed and operated independently. All required dependencies bundled into artifacts.

This type of software has the whole process loop and we can specify some tools that are standard for all of our projects. ![Deployable Applications Process Loop](/assets/715f6ff-Process_Loop_-_Deployable_Application_-_Page_1.png)Deployable Applications Process Loop
This type of software has the whole process loop and we can specify some tools that are standard for all of our projects.

{{< img src="/assets/715f6ff-Process_Loop_-_Deployable_Application_-_Page_1.png" title="Deployable Applications Process Loop" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ excerpt: ''

_Infrastructure as Code_ - is software that configures and operates basic infrastructure - servers, networking, kubernetes platform. Because this code manage very basic layer of system, it is applied manually by DevOps Engineer. _Infrastructure as Code_ - does not have the "operate" step, it modify infrastructure and then this infrastructure operates on cloud independently. Monitoring step use the common monitoring and alerting tools to monitor cloud infrastructure and notify about incidents.

![Infrastructure as a Code Process Loop](/assets/3cf5259-Process_Loop_-_Infrastructure_as_a_Code_-_Page_1.png)
{{< img src="/assets/3cf5259-Process_Loop_-_Infrastructure_as_a_Code_-_Page_1.png" title="Infrastructure as a Code Process Loop" >}}
3 changes: 2 additions & 1 deletion content/documentation/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: "Documentation"
excerpt: ""
icon: "fa fa-book"
---
{{% 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 %}}
2 changes: 1 addition & 1 deletion content/documentation/documentation-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ excerpt: Example of how to structure a document

# See Also

{{% dialog type="info" icon="fa-info-circle" title="References" %}}
{{% dialog type="info" icon="fa fa-info-circle" title="References" %}}
- Links to other sites
{{% /dialog %}}
7 changes: 4 additions & 3 deletions content/geodesic/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Geodesic
slug: geodesic
icon: "fa fa-cubes"
excerpt: >-
Geodesic is the fastest way to get up and running with a rock solid,
production-grade cloud platform.
Expand All @@ -21,9 +22,9 @@ Geodesic provides a fully customizable framework for defining and building world

# Demo

{{% dialog type="info" icon="fa-info-circle" title="Important" %}} This demo is *very* out-of-date. {{% /dialog %}}
{{% dialog type="info" icon="fa fa-info-circle" title="Important" %}} This demo is *very* out-of-date. {{% /dialog %}}

![demo video](https://media.giphy.com/media/26FmS6BRnPVPo2FDq/source.gif)
{{< img src="https://media.giphy.com/media/26FmS6BRnPVPo2FDq/source.gif" title="demo video" >}}

Geodesic is composed of two parts:

Expand All @@ -45,7 +46,7 @@ An organization may choose to leverage all of these components or just the parts
At its core, Geodesic is a framework for provisioning cloud infrastructure and the applications that sit on top of it. We leverage as many existing tools as possible to facilitate cloud fabrication and administration. We're like the connective tissue that sits between all of the components of a modern cloud.

| Tool | Purpose |
|:-------------------------------------------------------------------- |:--------------------------------------------------------------------------------------------------------------------------- |
|:---------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------|
| [`ansible`](http://docs.ansible.com/ansible/latest/index.html) | for automating configuration management. It can configure systems, deploy software, and orchestrate more advanced IT tasks. |
| [`goofys`](https://github.com/kahing/goofys/) | for mounting encrypted S3 buckets that store cluster configurations and secrets |
| [`packer`](https://github.com/hashicorp/packer/) | for creating identical machine images for multiple platforms |
Expand Down
2 changes: 1 addition & 1 deletion content/geodesic/module/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
title: "Module"
excerpt: ""
---
{{% 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 %}}
Loading

0 comments on commit d3c5fad

Please sign in to comment.