Skip to content

Commit 94c8e1e

Browse files
authored
Refine Metadata and Structure (#632)
* fix broken links * fix broken links * fix broken links * format design decisions, optimize side bar * fix sidebar positions * ordering and index pages * iconify everything * add more icons, reduce size * add a few more icons, fix margin
1 parent 8509d37 commit 94c8e1e

File tree

241 files changed

+984
-721
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

241 files changed

+984
-721
lines changed

docs/best-practices/developer/editor-config.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Editor Config Best Practices
33
sidebar_label: Editor Config
4-
description: "The EditorConfig enables developers to define and maintain consistent coding styles between different editors and IDEs. It consists of a simple file format (`.editorconfig`) for defining coding styles such as tabs vs spaces. Most text editors support the format and adhere to defined styles. The config files are easily readable and they work nicely with version control systems."
4+
description: "Enforce consistent formatting using a `.editorconfig`"
55
tags:
66
- best-practices
77
- developer

docs/best-practices/developer/github-sign-your-commits-with-ssh.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Sign Your GitHub Commits with SSH"
33
sidebar_label: "Sign GitHub Commits"
4+
description: Sign all your git commits
45
tags:
56
- best-practices
67
- developer

docs/best-practices/developer/makefile.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Makefile Best Practices"
3-
description: "We've written thousands of lines of Makefile. These are our best practices from the trenches."
3+
description: "Best practices for writing Makefiles"
44
sidebar_label: Makefiles
55
tags:
66
- developer

docs/best-practices/developer/markdown.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Markdown Best Practices
33
sidebar_label: Markdown
4-
description: "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."
4+
description: "Use consistent formatting conventions when writing Markdown"
55
tags:
66
- best-practices
77
- developer
@@ -12,8 +12,6 @@ import Intro from '@site/src/components/Intro';
1212
Most of our documentation is provided in Markdown format. Here are some of the conventions and best practices we follow when writing Markdown. Please note that we use the term Markdown loosely to refer to GitHub-flavored Markdown, and we also use quite a bit of MDX, which is what all of our documentation in Docusaurus uses.
1313
</Intro>
1414

15-
![Markdown Logo](/assets/13f56b6-markdown.png)
16-
1715
## Code Blocks
1816

1917
Use code blocks for anything more than 1 line. Use `code` for inline code, filenames, commands, etc.

docs/best-practices/developer/password-management.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
title: Password Management
33
sidebar_label: Password Management
4-
description: ''
4+
description: Use a password management solution with MFA
5+
icon: 'material-symbols-light:password'
56
tags:
67
- best-practices
78
- developer

docs/best-practices/developer/semver.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Semantic Versioning
33
sidebar_label: Semantic Versioning
4-
description: "Software versioning is the most widely adopted scheme for assigning unique version version numbers to software releases."
4+
description: "Use semantic versioning the way it was meant to be used"
55
tags:
66
- semver
77
- best-practices

docs/best-practices/github/github-feature-branches.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: GitHub Feature Branches
33
sidebar_label: Feature Branches
44
description: "Use separate branches for developing specific features."
5+
icon: 'carbon:branch'
56
tags:
67
- best-practices
78
- developer

docs/best-practices/github/github-pull-requests.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: GitHub Pull Requests
33
sidebar_label: Pull Requests
44
description: Best practices using Pull Requests on GitHub.
5+
icon: 'carbon:pull-request'
56
tags:
67
- best-practices
78
- developer

docs/best-practices/terraform.mdx

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,7 @@ description: "Our opinionated best-practices for Terraform"
55
tags:
66
- best-practices
77
- terraform
8-
image: /assets/08bcd99-terraform.png
98
---
10-
11-
![Terraform](/assets/08bcd99-terraform.png)
12-
139
These are the *opinionated* best-practices we follow at Cloud Posse. They are inspired by years of experience writing terraform
1410
and borrow on the many other helpful resources like those by [HashiCorp](https://www.terraform.io/docs/cloud/guides/recommended-practices/index.html).
1511

@@ -314,9 +310,7 @@ configuration to a separate template file.
314310

315311
Linting helps to ensure a consistent code formatting, improves code quality and catches common errors with syntax.
316312

317-
Run `terraform fmt` before committing all code. Use a `pre-commit` hook to
318-
do this automatically. See [Terraform Tips &
319-
Tricks](/reference/best-practices/terraform-tips-tricks.md)
313+
Run `terraform fmt` before committing all code. Use a `pre-commit` hook to do this automatically. See [Terraform Tips & Tricks](/learn/tips-and-tricks/terraform).
320314

321315
Consider using [`tflint`](https://github.com/terraform-linters/tflint) with
322316
the `aws` plugin.

docs/community/contact-us.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Contact Us
3-
description: 'Cloud Posse is a **DevOps Accelerator**.'
3+
description: 'Cloud Posse is a **DevOps Accelerator** and here to help you!'
44
sidebar_label: Contact Us
55
sidebar_position: 200
66
---

docs/community/contribute/contributor-tips.mdx

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,14 @@ tags:
77
- contribute
88
- developer
99
---
10+
import Intro from '@site/src/components/Intro';
1011
import Steps from '@site/src/components/Steps';
12+
import Note from '@site/src/components/Note';
1113

12-
## About
13-
14-
This document is intended to describe common and not-so-common processes that the contributor team executes as part of maintaining the 300+ open source projects within the Cloud Posse Organization.
1514

15+
<Intro>
16+
This document is intended to describe common and not-so-common processes that the contributor team executes as part of maintaining the 300+ open source projects within the Cloud Posse Organization.
17+
</Intro>
1618

1719
## Tips & Tricks
1820

@@ -60,8 +62,9 @@ Here is a standard usage pattern that contributors can adopt to specific changes
6062
-- \
6163
sh -c $PWD/$YOUR_SCRIPT_NAME.sh
6264
```
63-
64-
__NOTE__ the quotes around the message passing this as an argument to `-m` (message)
65+
<Note>
66+
the quotes around the message passing this as an argument to `-m` (message)
67+
</Note>
6568
1. Verify one of the repos that you're updating exemplifies the changes you're trying to make:
6669
1. `cd mp/terraform-aws-tfstate-backend/plan/planned/`
6770
1. `git show`

docs/community/office-hours.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Office Hours
2+
title: Office Hours Registration
33
sidebar_position: 3
44
sidebar_label: Office Hours
55
description: Office Hours with Cloud Posse
@@ -11,8 +11,6 @@ tags:
1111
import HubspotForm from 'react-hubspot-form'
1212
import { YouTubePlaylist } from '@codesweetly/react-youtube-playlist';
1313

14-
# Office Hours Registration
15-
1614
<HubspotForm
1715
portalId='2197148'
1816
region="na1"

docs/community/support.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22
title: "Community Support"
33
sidebar_label: "Support"
44
sidebar_position: 100
5+
description: Get support from our community
56
tags:
67
- support
78
- community
89
---
910

10-
# FAQ
1111
Here are some quick answers to frequently asked questions. See also our [Troubleshooting](/resources/legacy/troubleshooting).
1212

1313
## How can we support you?
1414

1515
By far, the hardest part of being an open-source company is surviving the financial reality that very few companies ever pay for open source. Any financial contribution you can make helps us continue operating as a business, and we've made this easy through GitHub sponsorships.
1616

1717

18-
<iframe src="https://github.com/sponsors/cloudposse/card" title="Sponsor Cloud Posse" style={{border: 0}}></iframe>
18+
<iframe src="https://github.com/sponsors/cloudposse/card" title="Sponsor Cloud Posse" style={{border: 0, width: '100%'}}></iframe>
1919

2020
## How do I request additional documentation?
2121

docs/intro/for-agencies.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Solutions For Agencies & Consultants
44
sidebar_label: For Agencies & Consultants
55
sidebar_position: 3
66
sidebar_class_name: divider
7-
description: "Standardize your delivery"
7+
description: "Standardize the delivery to your customers with a framework"
88
pagination_prev: intro/enterprises
99
tags:
1010
- agency

docs/intro/for-developers.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ id: developers
33
title: "Solutions for Application Developers"
44
sidebar_label: "For App Developers"
55
sidebar_position: 4
6+
description: "Focus on app development and ship faster"
67
tags:
78
- developers
89
---

docs/intro/for-startups.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
id: startups
33
title: Solutions for Startups
44
sidebar_label: "For Startups"
5-
description: "From startup to scale-up with flexible support."
5+
description: "Deliver your products faster, with support when you need it."
66
sidebar_position: 1
77
tags: [startups]
88
---

docs/intro/for-terraform-beginners.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ id: terraform-beginner
33
title: Solutions for Terraform Beginners
44
sidebar_label: "For Terraform Beginners"
55
sidebar_position: 5
6+
description: "Learn by doing and following our best practices"
7+
icon: "devicon:terraform"
68
tags:
79
- beginner
810
---

docs/intro/for-terraform-experts.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ id: terraform-expert
33
title: Solutions for Experienced Terraformers
44
sidebar_label: "For Terraform Experts"
55
sidebar_position: 6
6-
description: Cloud Posse offers flexible, efficient, and lifelong open-source infrastructure.
6+
description: Don't reinvent the wheel again, leverage a proven framework
7+
icon: "devicon:terraform"
78
tags:
89
- expert
910
---

docs/jumpstart/action-items.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Action Items
33
sidebar_label: Action Items
4-
sidebar_position: 3
4+
sidebar_position: 11
55
---
66
import Intro from '@site/src/components/Intro';
77
import Steps from '@site/src/components/Steps';
@@ -88,14 +88,14 @@ Before we can get started, here's the minimum information we need from you.
8888

8989
## GitHub Self-Hosted Runners
9090

91-
### Self Hosted Github Runners on EKS
91+
### Self-Hosted Github Runners on EKS
9292

9393
If you are deploying the Actions Runner Controller solution for Self-Hosted Github Runners, please generate the required secrets following the
94-
[GitHub Action Runner Controller setup docs](/reference-architecture/setup/github-arc/#requirements).
94+
[GitHub Action Runner Controller setup docs](/layers/github-actions/eks-github-actions-controller#requirements).
9595

9696
Feel free to store these secrets in 1Password if you do not have AWS access yet. Cloud Posse can complete the setup from there.
9797

98-
### Self Hosted Github Runners with Philips Labs (ECS)
98+
### Self-Hosted Github Runners with Philips Labs (ECS)
9999

100100
If you have chosen ECS as a platform, we recommend deploying Philips Labs GitHub Action Runners. Please read through the [Philips Labs GitHub Action Runners Setup Requirements](/layers/github-actions/philips-labs-github-runners#requirements).
101101

docs/jumpstart/faq.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: FAQ
33
sidebar_label: FAQ
4-
sidebar_position: 10
4+
sidebar_position: 15
55
description: Frequently Asked Questions
66
tags:
77
- faq
@@ -14,7 +14,7 @@ These are some of the most frequently asked questions by customers during our Ki
1414

1515
### What is the difference between a Service Discovery Domain and a Vanity Domain?
1616

17-
This is an extremely common question. Please see [What is the difference between a Vanity and a Service Domain?](/reference-architecture/fundamentals/network-and-dns/#what-is-the-difference-between-a-vanity-and-a-service-domain)
17+
This is an extremely common question. Please see [What is the difference between a Vanity and a Service Domain?](/layers/network#what-is-the-difference-between-a-vanity-and-a-service-domain)
1818

1919
### Do we have to use 1Password?
2020

docs/jumpstart/kick-off.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Kick Off with Cloud Posse"
33
sidebar_label: "Kick Off"
4-
sidebar_position: 2
4+
sidebar_position: 10
55
describe: Set project expectations for Jumpstarts with Cloud Posse
66
---
77
import Link from '@docusaurus/Link'
@@ -47,14 +47,14 @@ This document outlines what to expect from your first call with Cloud Posse. In
4747
<Step>
4848
### <StepNumber/> Project Overview
4949

50-
Cloud Posse will begin deploying your infrastructure following the [Reference Architecture](/reference-architecture/) and your team's design decisions. The Reference Architecture is a collection of best practices for building a secure, scalable, and highly available infrastructure on AWS. The Reference Architecture is a living document that is constantly evolving as we learn from our customers and the community.
50+
Cloud Posse will begin deploying your infrastructure [starting with the foundation](/layers/foundation) based your team's design decisions. The Reference Architecture is a collection of best practices for building a secure, scalable, and highly available infrastructure on AWS. The Reference Architecture is a living document that is constantly evolving as we learn from our customers and the community.
5151

52-
We will deploy your infrastructure in _layers_. These layers are designed to manage collections of deliverables and will be a mix of generated content from a private reference, vendored Terraform from open source libraries, and any customization for your Organization. Because we are delivering an entire infrastructure repository, these initial PRs will be massive; a complete infrastructure set up requires dozens of components, each with Terraform modules, configuration, account setup, and documentation. You are absolutely welcome to follow along, but we do not intend for your team to be required to review these massive PRs. Cloud Posse internally reviews these PRs extensively to ensure that the final product works as intended.
52+
We will deploy your infrastructure in _layers_. These layers are designed to manage collections of deliverables and will be a mix of generated content from a private reference, vendored Terraform from open-source libraries, and any customization for your Organization. Because we are delivering an entire infrastructure repository, these initial PRs will be massive; a complete infrastructure setup requires dozens of components, each with Terraform modules, configuration, account setup, and documentation. You are absolutely welcome to follow along, but we do not intend for your team to be required to review these massive PRs. Cloud Posse internally reviews these PRs extensively to ensure that the final product works as intended.
5353

54-
Once we're confident that we've deployed a given layer entirely, we then schedule the [Hand-Off Calls](#handoff-calls). A handoff call is intended to explain a given topic and provide the opportunity for your team to review and provide feedback on any given layer, as well as answer other questions. Before each Hand-Off Call we will have a [Fundamental Six Pager](/reference-architecture/category/fundamentals/) that goes into detail on the subject, but we can use the handoff calls however best suites your team. These calls can be a lecture of the material from the given six pager, a demo from Cloud Posse, or an opportunity practice hands-on labs.
54+
Once we're confident that we've deployed a given layer entirely, we then schedule the [Hand-Off Calls](#handoff-calls). A handoff call is intended to explain a given topic and provide the opportunity for your team to review and provide feedback on any given layer, as well as answer other questions. Before each Hand-Off Call, review the fundamentals of every layer by watching the videos. While we can use the handoff calls, teams can feel overwhelmed if they haven't watched any of the handoff videos beforehand. These calls can be a lecture on the material for any given layer, a demo from Cloud Posse, or an opportunity to practice with hands-on labs.
5555

5656
<Admonition type="tip">
57-
If you come prepared to a Hand-Off call, we can skip the lecture and spend more time answering questions or working through hands-on labs.
57+
If you come prepared for Hand-Off calls, we can skip the lecture and spend more time answering questions or working through hands-on labs.
5858
</Admonition>
5959
</Step>
6060

@@ -95,7 +95,7 @@ This document outlines what to expect from your first call with Cloud Posse. In
9595
</Step>
9696

9797
<Step>
98-
### <StepNumber/> Review [Design Decisions](/reference-architecture/fundamentals/design-decisions)
98+
### <StepNumber/> Review Design Decisions
9999

100100
<TaskList>
101101
- [ ] [Decide on Namespace Abbreviation](/layers/foundation/design-decisions/decide-on-namespace-abbreviation)
@@ -106,7 +106,7 @@ This document outlines what to expect from your first call with Cloud Posse. In
106106
- [ ] [Decide on Primary AWS Region and Secondary AWS Region](/layers/network/design-decisions/decide-on-primary-aws-region)
107107
- [ ] [Decide on CIDR Allocation Strategy](/layers/network/design-decisions/decide-on-cidr-allocation)
108108
- [ ] [Decide on Service Discovery Domain](/layers/network/design-decisions/decide-on-service-discovery-domain)
109-
- [ ] [Decide on Vanity Domain](/reference-architecture/reference/adrs/jumpstart/decide-on-vanity-domain/)
109+
- [ ] [Decide on Vanity Domain](/layers/network/design-decisions/decide-on-vanity-branded-domain)
110110
- [ ] [Decide on Release Engineering Strategy](/layers/software-delivery/design-decisions/decide-on-release-engineering-strategy)
111111
</TaskList>
112112
</Step>
@@ -117,11 +117,11 @@ This document outlines what to expect from your first call with Cloud Posse. In
117117
Generally, expect to schedule the following Handoff calls. These are subject to change and should be adaptable to fit your individual engagement.
118118
<TaskList>
119119
- [Kick Off](/jumpstart/kick-off)
120-
- [Introduction to Toolset](/reference-architecture/fundamentals)
121-
- [Identity and Authentication](/reference-architecture/fundamentals/iam-identity/)
120+
- [Introduction to Toolset](/layers/foundation)
121+
- [Identity and Authentication](/layers/identity)
122122
- [Component Development](/learn/component-development)
123-
- [Account Management](/reference-architecture/fundamentals/account-management/)
124-
- [Network and DNS](/reference-architecture/fundamentals/network-and-dns/)
123+
- [Account Management](/layers/accounts/)
124+
- [Network and DNS](/layers/network/)
125125
- [Spacelift](/layers/spacelift) or [GitOps](/layers/gitops)
126126
- [ECS](/layers/ecs) or [EKS](/layers/eks)
127127
- [Monitoring](/layers/monitoring) and [Alerting](/layers/alerting)

docs/jumpstart/onboarding.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Onboarding
33
sidebar_label: Onboarding
4-
sidebar_position: 4
4+
sidebar_position: 13
55
---
66
import TaskList from '@site/src/components/TaskList';
77

0 commit comments

Comments
 (0)