Skip to content

Commit f7e4f5c

Browse files
authored
More cleanup (#10)
* css for code block, warning and important * fix directory pages * white active menu; * fix footline on category pages * hide empty th * css fixes * more css fixes * fix editURL
1 parent dacc158 commit f7e4f5c

File tree

11 files changed

+217
-77
lines changed

11 files changed

+217
-77
lines changed

config.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ defaultContentLanguage = "en"
99
defaultContentLanguageInSubdir= false
1010
enableMissingTranslationPlaceholders = false
1111

12+
1213
enableEmoji = true
1314
# [Languages]
1415
# [Languages.en]
@@ -32,6 +33,7 @@ disableNavChevron = false # set true to hide next/prev chevron, default is false
3233
highlightClientSide = false # set true to use highlight.pack.js instead of the default hugo chroma highlighter
3334
menushortcutsnewtab = false # set true to open shortcuts links to a new tab/window
3435
enableGitInfo = true
36+
editURL = "https://github.com/cloudposse/docs/edit/master"
3537

3638
[outputFormats.glossary]
3739
baseName = "glossary"

content/devops-methodology/root-cause-analysis-postmortem/postmortem-example.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ excerpt: Example of a well-executed postmortem for Root Cause Analysis
55

66
# Incident #1 - Rollout Caused Unplanned Outage (2017-06-29)
77

8+
| | |
89
|:-----------------|:---------------------|
910
| On-call Engineer | Erik Osterman |
1011
| Start Time | 2018-06-29 12:58 PST |

content/documentation/contact-us.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ excerpt: ''
44
parent: home
55
---
66

7-
|
8-
------------- | ----------------------------------------------------------
9-
Inquiries | [hello@cloudposse.com](mailto:hello@cloudposse.com)
10-
Schedule Time | [calendly.com/cloudposse](https://calendly.com/cloudposse)
11-
Call | +1 (310) 496-6556
7+
| | |
8+
|:--------------|:-----------------------------------------------------------|
9+
| Inquiries | [hello@cloudposse.com](mailto:hello@cloudposse.com) |
10+
| Schedule Time | [calendly.com/cloudposse](https://calendly.com/cloudposse) |
11+
| Call | +1 (310) 496-6556 |

content/geodesic/geodesic-module/use/with-terraform.md

Lines changed: 35 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,16 @@ Then run these commands:
2828

2929
5. Re-run `init-terraform`, answer `yes` when asked to import state
3030

31-
##### :warning: Prerequisites
32-
> Follow the "Use geodesic module" to [Use](doc:use) get how to use the module shell.
31+
{{% dialog type="warning" icon="fa-exclamation-circle" title="Prerequisites" %}}
32+
Follow the "Use geodesic module" to [Use](doc:use) get how to use the module shell.
33+
{{% /dialog %}}
3334

3435
# Create terraform state bucket
3536

36-
##### :no_entry_sign: Important
37-
> To use terraform you need to create terraform state bucket.
38-
>Follow the instructions to do that.
37+
{{% dialog type="important" icon="fa-exclamation-triangle" title="Important" %}}
38+
To use terraform you need to create terraform state bucket.
39+
Follow the instructions to do that.
40+
{{% /dialog %}}
3941

4042
To create terraform state bucket follow this steps:
4143

@@ -129,7 +131,7 @@ Run Geodesic Shell in [development mode](doc:use#section-development-mode)
129131
> $CLUSTER_NAME
130132
```
131133

132-
##### Example
134+
{{% dialog type="code-block" icon="fa-code" title="Example" %}}
133135
```shell
134136
> staging.example.com
135137
# Mounting /home/goruha into container
@@ -156,14 +158,15 @@ IMPORTANT:
156158
❌ (none) ~ ➤
157159
158160
```
161+
{{% /dialog %}}
159162
160163
## Authorize on AWS
161164
Assume role by running
162165
```bash
163166
assume-role
164167
```
165168
166-
##### Example
169+
{{% dialog type="code-block" icon="fa-code" title="Example" %}}
167170
```shell
168171
❌ (none) tfstate-backend ➤ assume-role
169172
Enter passphrase to unlock /conf/.awsvault/keys/:
@@ -174,6 +177,7 @@ Enter token for arn:aws:iam::xxxxxxx:mfa/goruha: 781874
174177
✅ (example-staging-admin) tfstate-backend ➤
175178
176179
```
180+
{{% /dialog %}}
177181
178182
## Apply tfstate-bucket
179183
@@ -185,7 +189,7 @@ terraform apply
185189
```
186190
The latest command will output id of terraform state bucket and dynamo DB table. Please copy that values because we need it for next step.
187191
188-
##### Example
192+
{{% dialog type="code-block" icon="fa-code" title="Example" %}}
189193
```shell
190194
✅ (example-staging-admin) tfstate-backend ➤ terraform apply
191195
null_resource.default: Refreshing state... (ID: 4514126170089387416)
@@ -207,13 +211,14 @@ tfstate_backend_s3_bucket_id = example-staging-terraform-state
207211
✅ (example-staging-admin) tfstate-backend ➤
208212
209213
```
214+
{{% /dialog %}}
210215
211216
In the example the bucket name is `example-staging-terraform-state` and dynamo DB table `example-staging-terraform-state-lock`.
212217
213218
## Exit the module shell
214219
Exit from the shell by running `exit` twice
215220
216-
##### Example
221+
{{% dialog type="code-block" icon="fa-code" title="Example" %}}
217222
```shell
218223
✅ (example-staging-admin) tfstate-backend ➤ exit
219224
logout
@@ -223,8 +228,8 @@ Goodbye
223228
❌ (none) ~ ➤ exit
224229
logout
225230
Goodbye
226-
227231
```
232+
{{% /dialog %}}
228233
229234
## Set the bucket as default bucket to store for terraform state files
230235
Update in module `Dockerfile` environment variables
@@ -236,7 +241,7 @@ ENV TF_DYNAMODB_TABLE ""
236241
```
237242
with terraform state bucket name and region and dynamo DB table name.
238243
239-
##### Example
244+
### Example
240245
```text
241246
# Terraform
242247
ENV TF_BUCKET "example-staging-terraform-state"
@@ -257,7 +262,7 @@ Run Geodesic Shell in [development mode](doc:use#section-development-mode)
257262
> assume-role
258263
```
259264
260-
##### Example
265+
{{% dialog type="code-block" icon="fa-code" title="Example" %}}
261266
```shell
262267
> staging.example.com
263268
# Mounting /home/goruha into container
@@ -289,33 +294,32 @@ Enter token for arn:aws:iam::xxxxxxx:mfa/goruha: 781874
289294
⧉ staging example
290295
✅ (example-staging-admin) tfstate-backend ➤
291296
```
297+
{{% /dialog %}}
292298
293299
## Save `tfstate-bucket` terraform state file into the bucket
294300
This is kind of self-reference but we need to store state in reliable storage. This is useful for the future update.
295301
296302
297-
# Create terraform module
298-
299-
303+
# Create Terraform Module
300304
301305
To provision terraform module create a directory for it in `/conf`
302306
303-
##### :information_source: Example
304-
> If terraform module name is `kube2iam`.
305-
>Create `/conf/kube2iam` and put there terraform code.
306-
>Example of code you can find there [LINK!]
307+
{{% dialog type="tip" icon="fa-hand-o-right" title="Tip" %}}
308+
If the terraform module is named `kube2iam`, then create `/conf/kube2iam` and stick the terraform code in there.
309+
Example of code you can find there [LINK!]
310+
{{% /dialog %}}
307311
308-
# Rebuild the shell container
312+
# Rebuild the Geodesic Module
309313
310314
Rebuild the shell container with `make build` command.
311315
312-
{{% dialog type="info" icon="fa-info-circle" title="Tip" %}}
316+
{{% dialog type="tip" icon="fa-hand-o-right" title="Tip" %}}
313317
During development, you can skip rebuilding the container and instead work from the `/localhost` folder inside of the container. The `/localhost` folder is the user's `$HOME` folder mounted into the container. Any files on this system will be persisted.
314318
{{% /dialog %}}
315319
316320
# Run the shell
317321
```bash
318-
> $CLUSTER_NAME
322+
$CLUSTER_NAME
319323
```
320324
321325
For example, to access your geodesic project shell do the following.
@@ -339,12 +343,15 @@ terraform plan
339343
terraform apply
340344
```
341345
342-
##### :information_source: Example
343-
> If terraform module name is `kube2iam`.
344-
>`> cd /conf/kube2iam`
345-
>`> init-terraform`
346-
>`> terraform plan`
347-
>`> terraform apply`
346+
{{% dialog type="code-block" icon="fa-code" title="Example" %}}
347+
If terraform module name is `kube2iam`.
348+
```bash
349+
cd /conf/kube2iam
350+
init-terraform
351+
terraform plan
352+
terraform apply
353+
```
354+
{{% /dialog %}}
348355
349356
## Example: Provision CloudTrail with Terraform
350357

content/helm-charts/helm-quick-start.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@ Helm is a package manager for kubernetes.
66

77
There are a vast number of public charts available: https://github.com/kubernetes/charts/
88

9-
10-
##### :information_source: Official Documentation
11-
> Visit the [Helm Documentation Portal](https://docs.helm.sh/) for excellent documentation
12-
9+
{{% dialog type="info" icon="fa-info-circle" title="Official Documentation" %}}
10+
Visit the [Helm Documentation Portal](https://docs.helm.sh/) for excellent documentation
11+
{{% /dialog %}}
1312

1413
# Values File
1514

content/kubernetes-backing-services/ingress/_index.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Configuring a web server or load balancer used to be harder than it should be, e
77
Typically, services and pods have IPs only routable by the cluster network. All traffic that ends up at an edge router is either dropped or forwarded elsewhere. Conceptually, this might look like:
88

99

10-
#####
10+
#####
1111
```yaml
1212
internet
1313
|
@@ -18,7 +18,7 @@ Typically, services and pods have IPs only routable by the cluster network. All
1818
An Ingress is a collection of rules that allow inbound connections to reach the cluster services.
1919

2020

21-
#####
21+
#####
2222
```yaml
2323
internet
2424
|
@@ -56,13 +56,15 @@ In order for the Ingress resource to work, the cluster must have an Ingress cont
5656
5757
An Ingress Controller is a daemon, deployed as a Kubernetes Pod, that watches the API server's /ingresses endpoint for updates to the Ingress resource. Its job is to satisfy requests for Ingresses.
5858
59-
##### :information_source: Note
60-
> In theory, you can install several ingress controllers, for example, for different types of service.
61-
>This would require you to specify explicitly which instance of the ingress controller to associate with. Therefore, we recommend to only have one controller per cluster.
59+
{{% dialog type="info" icon="fa-info-circle" title="Note" %}}
60+
In theory, you can install several ingress controllers, for example, for different types of service.
61+
This would require you to specify explicitly which instance of the ingress controller to associate with. Therefore, we recommend to only have one controller per cluster.
62+
{{% /dialog %}}
6263
6364
Here is a list of controllers we support:
6465
6566
* [Nginx Ingress Controller](doc:nginx-ingress-controller)
6667
67-
##### :information_source: Read more
68-
> https://kubernetes.io/docs/concepts/services-networking/ingress
68+
{{% dialog type="info" icon="fa-info-circle" title="Read More" %}}
69+
https://kubernetes.io/docs/concepts/services-networking/ingress
70+
{{% /dialog %}}

content/kubernetes/kubernetes-pull-secrets.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,10 @@ kops create secret dockerconfig
3333
```
3434

3535

36-
##### :information_source: READ MORE
37-
> [github.com/kubernetes/kops/blob/master/docs/cli/kops_create_secret_dockerconfig.md](https://github.com/kubernetes/kops/blob/master/docs/cli/kops_create_secret_dockerconfig.md)
3836

37+
{{% dialog type="info" icon="fa-info-circle" title="Read More" %}}
38+
[github.com/kubernetes/kops/blob/master/docs/cli/kops_create_secret_dockerconfig.md](https://github.com/kubernetes/kops/blob/master/docs/cli/kops_create_secret_dockerconfig.md)
39+
{{% /dialog %}}
3940

4041
# Kubernetes
4142

content/project-management/gost-framework.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,32 +15,36 @@ A goal defines a broad primary outcome. This is the business driver and should r
1515

1616
**Example**: "Improve user productivity for most popular pages across our site"
1717

18-
##### :information_source: HINT
19-
> The goal should not include any objectives, strategies or tactics. It's very high-level and should be easily understood by anyone in the business.
18+
{{% dialog type="tip" icon="fa-info-circle" title="Tip" %}}
19+
The goal should not include any objectives, strategies or tactics. It's very high-level and should be easily understood by anyone in the business.
20+
{{% /dialog %}}
2021

2122
# Objectives
2223

2324
List of measurable outcomes that will be achieved by executing the strategies. Objectives describe *what* will be achieved by the goal. This is the barometer for success. It's how we will know we've achieved our goal.
2425

2526
**Example**: "Reduce page load times by 25%"
2627

27-
##### :information_source: HINT
28-
> Typlically, these objectives are described using the following terms: "minimize", "increase", "reduce", "eliminate".
28+
{{% dialog type="tip" icon="fa-info-circle" title="Tip" %}}
29+
Typically, these objectives are described using the following terms: "minimize", "increase", "reduce", "eliminate".
30+
{{% /dialog %}}
2931

3032
# Strategies
3133

3234
The specific approach that will be taken to achieve a goal and objectives. They describe *why* the objectives will be met, therefore try to map all the strategies to the objectives.
3335

3436
**Example**: "Use caching to reduce page load times"
3537

36-
##### :information_source: HINT
37-
> Strategies should not encompass any tactics. That is, there might be multiple tacts that can be executed to fulfill the strategy. This is geared towards the CIO/CTO audience that might not be well versed on the tactics. For example, "Use Caching to reduce page load times"
38+
{{% dialog type="tip" icon="fa-info-circle" title="Tip" %}}
39+
Strategies should not encompass any tactics. That is, there might be multiple tacts that can be executed to fulfill the strategy. This is geared towards the CIO/CTO audience that might not be well versed on the tactics. For example, "Use Caching to reduce page load times"
40+
{{% /dialog %}}
3841

3942
# Tactics
4043

4144
Tactics describe *how* specific tools will be used to implement the strategies. Try to map the tools to the strategies.
4245

4346
**Example**: "Use Memcache to cache API responses"
4447

45-
##### :information_source: HINT
46-
> Tactics describe the exact solution that will be implemented by the engineering team. Typically, this is a list of technologies (E.g. MySQL, Memcache, Kubernetes, Helm, Docker, etc)
48+
{{% dialog type="tip" icon="fa-info-circle" title="Tip" %}}
49+
Tactics describe the exact solution that will be implemented by the engineering team. Typically, this is a list of technologies (E.g. MySQL, Memcache, Kubernetes, Helm, Docker, etc)
50+
{{% /dialog %}}

content/release-engineering/build-harness.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ excerpt: ''
55

66
The `build-harness` is a collection of [Makefiles](doc:makefile) to facilitate building stuff. It supports Golang projects, Dockerfiles, Helm charts, and much more.
77

8-
|
9-
------------ | --------------------------------------------------------------------------------------------------------------------------------------
10-
GitHub Repo | <https://raw.githubusercontent.com/cloudposse/build-harness>
11-
Build Status | [![Build Status](https://travis-ci.org/cloudposse/build-harness.svg)](https://travis-ci.org/cloudposse/build-harness)
12-
Release | [![Release](https://img.shields.io/github/release/cloudposse/build-harness.svg)](https://github.com/cloudposse/build-harness/releases)
8+
| | |
9+
|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|
10+
| GitHub Repo | <https://raw.githubusercontent.com/cloudposse/build-harness> |
11+
| Build Status | [![Build Status](https://travis-ci.org/cloudposse/build-harness.svg)](https://travis-ci.org/cloudposse/build-harness) |
12+
| Release | [![Release](https://img.shields.io/github/release/cloudposse/build-harness.svg)](https://github.com/cloudposse/build-harness/releases) |
1313

1414
It's designed to work with CI/CD systems such as Travis CI, CircleCI, CodeFresh and Jenkins.
1515

@@ -39,12 +39,12 @@ Run `make help` for a list of available targets.
3939

4040
We leverage the `build-harness` in nearly every project on our [GitHub](doc:github).
4141

42-
|
43-
--------------------------------------------------------------------------------- | --------------------------------------------------------------------------
44-
[`github-authorized-keys`](https://github.com/cloudposse/github-authorized-keys/) | A Golang project that leverages `docker/%`, `go/%`, `travis/%` targets
45-
[`charts`](https://github.com/cloudposse/charts/) | A collection of Helm Charts that leverages `docker/%` and `helm/%` targets
46-
[`bastion`](https://github.com/cloudposse/bastion/) | A docker image that leverages `docker/%` and `bash/lint` targets
47-
[`terraform-null-label`](https://github.com/cloudposse/terraform-null-label/) | A terraform module that leverages `terraform/%` targets
42+
| | |
43+
|:----------------------------------------------------------------------------------|:---------------------------------------------------------------------------|
44+
| [`github-authorized-keys`](https://github.com/cloudposse/github-authorized-keys/) | A Golang project that leverages `docker/%`, `go/%`, `travis/%` targets |
45+
| [`charts`](https://github.com/cloudposse/charts/) | A collection of Helm Charts that leverages `docker/%` and `helm/%` targets |
46+
| [`bastion`](https://github.com/cloudposse/bastion/) | A docker image that leverages `docker/%` and `bash/lint` targets |
47+
| [`terraform-null-label`](https://github.com/cloudposse/terraform-null-label/) | A terraform module that leverages `terraform/%` targets |
4848

4949
# Makefile Targets
5050

layouts/partials/flex/body-beforecontent.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ <h1>The Cloud Posse Developer Hub</h1>
100100
{{- end}}
101101
<h1 class="title">{{.Title}}</h1>
102102
<div class="github-link">
103-
<a href="{{ .Site.Params.editURL }}{{ replace .File.Dir "\\" "/" }}{{ .File.LogicalName }}" target="blank"><i class="fa fa-edit"></i>{{T "Edit-this-page"}}</a>
103+
<a href="{{ .Site.Params.editURL }}/content/{{ .File.Path }}" target="blank"><i class="fa fa-edit"></i>{{T "Edit-this-page"}}</a>
104104
</div>
105105
<div class="excerpt">
106106
{{ if .Params.excerpt }}

0 commit comments

Comments
 (0)