Skip to content

Commit 322d3d9

Browse files
ostermanosterman
authored
Import Content (#627)
* import gitops * New TagList component * fix keyboard shortcuts when other key combinations are pressed, broken links, index pages, etc * disable console.log * remove image sizes which are frequently wrong due to bad export from confluence * add missing file, update nav * disable console log * debug failures * debug failures * debug failures * debug failures * content updates * content updates * import spacelift docs
1 parent 6d581e3 commit 322d3d9

File tree

211 files changed

+2864
-702
lines changed

Some content is hidden

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

211 files changed

+2864
-702
lines changed

‎docs/best-practices/best-practices.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ sidebar_label: Best Practices
44
sidebar_class_name: hidden
55
sidebar_position: 0
66
description: Cloud Posse's Opinionated Reference Architecture Best Practices
7+
tags:
8+
- best-practices
79
---
810

911
> <q>Physics is the law, everything else is a recommendation.

‎docs/best-practices/developer/developer.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ description: "We've written thousands of lines of code. These are our best pract
55
tags:
66
- best-practices
77
- developer
8-
- code
98
---
109
import DocCardList from '@theme/DocCardList';
1110
import Intro from '@site/src/components/Intro';

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,8 @@ title: Editor Config Best Practices
33
sidebar_label: Editor Config
44
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."
55
tags:
6-
- code style
7-
- formatting
8-
- .editorconfig
6+
- best-practices
7+
- developer
98
---
109
import Intro from '@site/src/components/Intro';
1110

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
22
title: "Sign Your GitHub Commits with SSH"
33
sidebar_label: "Sign GitHub Commits"
4+
tags:
5+
- best-practices
6+
- developer
7+
- github
48
---
59

610
If you are already using SSH to authenticate to GitHub, it is very easy to sign all your commits as well, as long as you have already installed Git 2.34.0 or later. (Note, there may be problems with OpenSSH 8.7. Use an earlier or later version. I have this working with OpenSSH 8.1p1.)

‎docs/best-practices/developer/makefile.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@ title: "Makefile Best Practices"
33
description: "We've written thousands of lines of Makefile. These are our best practices from the trenches."
44
sidebar_label: Makefiles
55
tags:
6+
- developer
67
- tool
78
- make
8-
- Makefile
9+
- makefile
910
- best-practices
1011
---
1112
import Intro from '@site/src/components/Intro';

‎docs/best-practices/developer/markdown.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
title: Markdown Best Practices
33
sidebar_label: Markdown
44
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."
5+
tags:
6+
- best-practices
7+
- developer
58
---
69
import Intro from '@site/src/components/Intro';
710

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
title: Password Management
33
sidebar_label: Password Management
44
description: ''
5+
tags:
6+
- best-practices
7+
- developer
58
---
69

710
We strongly advise all companies to use "1Password for Teams" as their password management solution.

‎docs/best-practices/developer/semver.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ title: Semantic Versioning
33
sidebar_label: Semantic Versioning
44
description: "Software versioning is the most widely adopted scheme for assigning unique version version numbers to software releases."
55
tags:
6-
- semver
6+
- semver
7+
- best-practices
8+
- developer
79
---
810

911
We practice [Semantic Versioning](https://semver.org/) for all projects (e.g. GitHub Tags/Releases, Helm Charts, Terraform Modules, Docker Images). Using this versioning standard helps to reduce the entropy related to [Dependency Hell](https://en.wikipedia.org/wiki/Dependency_hell).

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: GitHub Feature Branches
33
sidebar_label: Feature Branches
44
description: "Use separate branches for developing specific features."
5+
tags:
6+
- best-practices
7+
- developer
8+
- github
59
---
610
import Intro from '@site/src/components/Intro'
711

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ title: GitHub Pull Requests
33
sidebar_label: Pull Requests
44
description: Best practices using Pull Requests on GitHub.
55
tags:
6-
- "Best Practices"
6+
- best-practices
7+
- developer
8+
- github
79
---
810

911
## Submitting a Pull Request

‎docs/best-practices/github/github.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
22
title: "GitHub Best Practices"
33
sidebar_label: "GitHub"
4+
tags:
5+
- best-practices
6+
- developer
7+
- github
48
---
59

610
## Use `.gitignore`

‎docs/best-practices/terraform.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
title: "Terraform Best Practices"
33
sidebar_label: "Terraform"
44
description: "Our opinionated best-practices for Terraform"
5-
slug: "terraform-best-practices"
65
tags:
7-
- "Best Practices"
8-
- "Terraform"
6+
- best-practices
7+
- terraform
8+
image: /assets/08bcd99-terraform.png
99
---
1010

1111
![Terraform](/assets/08bcd99-terraform.png)
1212

1313
These are the *opinionated* best-practices we follow at Cloud Posse. They are inspired by years of experience writing terraform
1414
and borrow on the many other helpful resources like those by [HashiCorp](https://www.terraform.io/docs/cloud/guides/recommended-practices/index.html).
1515

16-
See our general [Best Practices](/category/best-practices/) which also apply to Terraform.
16+
See our general [Best Practices](/best-practices/) which also apply to Terraform.
1717

1818
## Variables
1919

‎docs/community/code-of-conduct.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
title: Code of Conduct
33
description: This is our Contributor Covenant Code of Conduct.
44
tags:
5-
- open-source
6-
- agreement
5+
- community
6+
- code-of-conduct
77
---
88
import Intro from '@site/src/components/Intro';
99

‎docs/community/contribute/automated-testing.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: Terraform Automated Testing
33
sidebar_label: Automated Testing
44
description: 'Our automated testing strategy and resources'
5+
tags:
6+
- community
7+
- contribute
8+
- developer
59
---
610
import Intro from '@site/src/components/Intro';
711
import Steps from '@site/src/components/Steps';

‎docs/community/contribute/code-reviews.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
title: "Code Review Guidelines"
33
description: "Code Review Guidelines"
44
tags:
5-
- "Best Practices"
6-
- "Development"
5+
- developer
6+
- community
77
---
88
import Steps from '@site/src/components/Steps';
99

10-
Here are some of our tips for conducting *Code Reviews* the SweetOps way. If you haven't already, become familiar with our [Best Practices](/category/best-practices/) and [Terraform Best Practices](/reference/best-practices/terraform-best-practices.md).
10+
Here are some of our tips for conducting *Code Reviews* the SweetOps way. If you haven't already, become familiar with our [Best Practices](/category/best-practices/) and [Terraform Best Practices](/best-practices/terraform).
1111

1212
<Steps>
1313
1. Use the ["Suggest"](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) feature as much as possible. This makes it quick and easy for the contributor to accept or dismiss the recommendations.

‎docs/community/contribute/contribute.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
title: GitHub Contributors
33
description: 'GitHub Contributors'
44
sidebar_class_name: hidden
5+
tags:
6+
- community
7+
- contribute
58
---
69

710
## About

‎docs/community/contribute/contributor-tips.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: Contributor Tips & Tricks
33
sidebar_label: Tips & Tricks
44
description: 'Contributor Tips & Tricks'
5+
tags:
6+
- tips-and-tricks
7+
- contribute
8+
- developer
59
---
610
import Steps from '@site/src/components/Steps';
711

‎docs/community/contribute/faq.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
title: GitHub Contributors FAQ
33
sidebar_label: FAQ
44
description: 'GitHub Contributors FAQ'
5+
tags:
6+
- faq
7+
- contribute
58
---
69

710
## How do I see all open Pull Requests?
@@ -16,7 +19,7 @@ why something happened than blame or chastise our volunteers.
1619

1720
## What are your best-practices we should follow?
1821

19-
See our [Terraform Best Practices](/reference/best-practices/terraform-best-practices.md) and [Best Practices](/category/best-practices/). These are just some guidelines to follow and we're open to your feedback!
22+
See our [Terraform Best Practices](/best-practices/terraform) and [Best Practices](/best-practices/). These are just some guidelines to follow and we're open to your feedback!
2023

2124
## What benefits do I receive as a contributor?
2225

‎docs/community/contribute/our-github.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: "Our GitHub"
33
description: "Information on how to collaborate with Cloud Posse"
44
sidebar_position: 100
5+
tags:
6+
- contribute
57
---
68
import Steps from '@site/src/components/Steps';
79
import Note from '@site/src/components/Note';

‎docs/community/office-hours.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ sidebar_position: 3
44
sidebar_label: Office Hours
55
description: Office Hours with Cloud Posse
66
id: office-hours
7+
tags:
8+
- office-hours
9+
- community
710
---
811
import HubspotForm from 'react-hubspot-form'
912
import { YouTubePlaylist } from '@codesweetly/react-youtube-playlist';

‎docs/community/slack.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ sidebar_position: 3
44
sidebar_label: Slack
55
description: Cloud Posse's SweetOps Slack Community
66
id: slack
7+
tags:
8+
- slack
9+
- community
710
---
811

912
## Join our Slack Community!

‎docs/community/support.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
title: "Community Support"
33
sidebar_label: "Support"
44
sidebar_position: 100
5+
tags:
6+
- support
7+
- community
58
---
69

710
# FAQ
@@ -12,7 +15,7 @@ Here are some quick answers to frequently asked questions. See also our [Trouble
1215
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.
1316

1417

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

1720
## How do I request additional documentation?
1821

‎docs/components/library/library.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Terraform Components
3+
sidebar_label: Terraform Components
4+
sidebar_position: 0
5+
sidebar_class_name: hidden
6+
description: Libary of Terraform Root Module Components
7+
---
8+
import Intro from '@site/src/components/Intro';
9+
import DocCardList from '@theme/DocCardList';
10+
11+
<Intro>
12+
This is a libary of reusable Terraform "root module" components.
13+
</Intro>
14+
15+
<DocCardList/>

‎docs/intro/for-agencies.mdx

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,26 @@
11
---
2-
title: Solutions For Agencies
3-
sidebar_label: For Agencies
2+
id: agencies
3+
title: Solutions For Agencies & Consultants
4+
sidebar_label: For Agencies & Consultants
45
sidebar_position: 3
56
sidebar_class_name: divider
6-
description: "Standardize your delivery."
7+
description: "Standardize your delivery"
8+
pagination_prev: intro/enterprises
9+
tags:
10+
- agency
711
---
812
import Intro from '@site/src/components/Intro';
13+
import ActionCard from '@site/src/components/ActionCard';
14+
import PrimaryCTA from '@site/src/components/PrimaryCTA';
915

1016
<Intro>
1117
As an agency, moving quickly and serving numerous customers efficiently is a constant challenge. You've likely standardized your application stack language and framework—now it's time to standardize your infrastructure too.
1218
</Intro>
1319

1420
By leveraging our reference architecture for AWS, you can focus more on solving your customers' problems and less on the details of the tooling itself. Customize it to your needs and develop common, reusable patterns across all your projects, scaling as necessary. With our component and module library, you won't need to worry about creating original Terraform code. Instead, you can immediately benefit from what's already built and supported by our community.
21+
22+
<ActionCard title="What comes next?">
23+
Now that you know the reference architecture will work for your customers, you're ready to get started with your first project.
24+
25+
<PrimaryCTA to="/layers/foundation">Next Step</PrimaryCTA>
26+
</ActionCard>

‎docs/intro/for-developers.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,22 @@ id: developers
33
title: "Solutions for Application Developers"
44
sidebar_label: "For App Developers"
55
sidebar_position: 4
6+
tags:
7+
- developers
68
---
79
import Intro from '@site/src/components/Intro';
10+
import ActionCard from '@site/src/components/ActionCard';
11+
import PrimaryCTA from '@site/src/components/PrimaryCTA';
812

913
<Intro>
1014
As a developer, leveraging the Cloud Posse reference architecture offers a robust framework for team collaboration, with thorough documentation and community support, saving time and effort while providing a strong foundation for your infrastructure.
1115
</Intro>
1216

1317
If you're a developer, chances are you're entering a system already utilizing the Cloud Posse reference architecture set up by others in your organization, or you're being asked for advice on managing the next generation of your infrastructure. As a developer, you know the importance of using an established framework for any project—it provides consistent conventions, comprehensive documentation, and access to a supportive community. This is exactly what we offer. By tapping into the Cloud Posse reference architecture, you're building on a robust framework with thorough documentation, saving you significant time and effort in building your infrastructure. While there may be a learning curve, once you grasp it, you'll be far ahead of any company starting from scratch.
18+
19+
20+
<ActionCard title="What comes next?">
21+
Now that you know what the reference architecture is for you, you're ready to get started with your first project.
22+
23+
<PrimaryCTA to="/layers/foundation">Next Step</PrimaryCTA>
24+
</ActionCard>

‎docs/intro/for-enterprises.mdx

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,14 @@ title: Solutions for Enterprises
44
sidebar_label: "For Enterprises"
55
sidebar_position: 2
66
description: Adopt a framework that streamlines enterprise infrastructure
7+
pagination_next: intro/agencies
8+
tags:
9+
- enterprise
710
---
811
import Intro from '@site/src/components/Intro';
12+
import Steps from '@site/src/components/Steps';
13+
import ActionCard from '@site/src/components/ActionCard';
14+
import PrimaryCTA from '@site/src/components/PrimaryCTA';
915

1016
<Intro>
1117
As an enterprise, your monumental success over time has likely come at the significant cost of technical debt. As infrastructure grew organically, it's systems became complex and brittle. Many of those who built it, may no longer be around to support it. Now it's time to bring order to this chaos, thinking about the long-term success of your organization.
@@ -17,4 +23,38 @@ By adopting this reference architecture for AWS and the framework it's built upo
1723
- Security & Compliance
1824
- Scalability
1925

26+
## Getting Started
27+
28+
<Steps>
29+
1. ### Initiate a Proof of Concept (POC)
30+
- Set up the reference architecture within your AWS organization
31+
- Deploy a simple application to understand the setup and capabilities
32+
- Evaluate the fit and identify any customization needs
33+
34+
2. ### Assess Current Infrastructure
35+
- Conduct an inventory of existing infrastructure
36+
- Identify areas of technical debt and potential risks
37+
- Map current infrastructure components to the reference architecture
38+
39+
3. ### Plan the Adoption
40+
- Develop a roadmap for the transition
41+
- Define key milestones and deliverables
42+
- Establish governance and compliance frameworks aligned with the reference architecture
43+
44+
4. ### Pilot Phase
45+
- Select a small, manageable project to pilot the framework
46+
- Implement the reference architecture components and gather feedback
47+
- Establish continuous integration and continuous deployment (CI/CD) pipelines
48+
49+
5. ### Scale Implementation
50+
- Roll out the reference architecture across multiple projects
51+
- Train teams on new processes and tools
52+
- Iterate on the architecture and processes based on real-world usage
53+
</Steps>
54+
55+
<ActionCard title="What comes next?">
56+
Now that you understand how the reference architecture can work for you, you're ready to get started with your first Proof of Concept.
57+
58+
<PrimaryCTA to="/layers/foundation">Next Step</PrimaryCTA>
59+
</ActionCard>
2060

0 commit comments

Comments
 (0)