-
-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update titles and sidebar titles, convert all pages to MDX (#624)
* formatting * rename for consistency. update titles. * update titles and sidebar lables. swizzle doccard components
- Loading branch information
Showing
484 changed files
with
1,533 additions
and
1,330 deletions.
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
> <q>Physics is the law, everything else is a recommendation. | ||
> Anyone can break laws created by people, but I have yet to see anyone break the laws of physics. | ||
> <p className="author">— **Elon Musk**</p></q> |
File renamed without changes.
File renamed without changes.
6 changes: 6 additions & 0 deletions
6
docs/best-practices/docker-best-practices.md → docs/best-practices/docker.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 6 additions & 1 deletion
7
...best-practices/github-feature-branches.md → ...est-practices/github-feature-branches.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,46 +1,20 @@ | ||
--- | ||
title: "FAQ" | ||
confluence: https://cloudposse.atlassian.net/wiki/spaces/REFARCH/pages/1176371788/FAQ | ||
title: "Community Support" | ||
sidebar_label: "Support" | ||
sidebar_position: 100 | ||
custom_edit_url: https://github.com/cloudposse/refarch-scaffold/tree/main/docs/docs/faq.md | ||
--- | ||
|
||
# FAQ | ||
Here are some quick answers to frequently asked questions. See also our [Troubleshooting](/reference-architecture/reference/troubleshooting) . | ||
Here are some quick answers to frequently asked questions. See also our [Troubleshooting](/reference-architecture/reference/troubleshooting). | ||
|
||
## Documentation | ||
|
||
### How do I request additional documentation? | ||
|
||
Please request documentation via your given team's Slack channel. | ||
Please request documentation by opening a [GitHub Issue](https://github.com/cloudposse/docs/issues). Please provide as much detail as possible about what you would like to see documented and what related documents you discovered that were not helpful. | ||
|
||
### What’s the difference between this documentation and our public documentation? | ||
|
||
Our [public documentation](/) is written more generally since we cannot make any assumptions about how the public is using our tools. The reference architecture documentation is more opinionated on how we use our tools, for example, how we layout stacks, components, etc. | ||
|
||
## Terraform | ||
|
||
### How to upgrade Terraform? | ||
|
||
See [How to Switch Versions of Terraform](/reference-architecture/how-to-guides/tutorials/how-to-switch-versions-of-terraform) for a more complete guide. | ||
|
||
TL;DR: | ||
|
||
- Note the version you want to use | ||
- Make sure the version is available in [cloudposse/packages](https://github.com/cloudposse/packages/pulls?q=terraform) to see if the version desired is in a merged PR for terraform | ||
- Make sure the version is available in Spacelift by editing an existing stack and see if the new version is available | ||
- Update Terraform in `Dockerfile` | ||
- Update Terraform in `.github/workflows/pre-commit.yaml` github action | ||
- Update Terraform in `components/terraform/spacelift/default.auto.tfvars` | ||
|
||
### How to use `context.tf`? | ||
|
||
Copy this file from `https://github.com/cloudposse/terraform-null-label/blob/master/exports/context.tf` and then place it in your Terraform module to automatically get Cloud Posse's standard configuration inputs suitable for passing to Cloud Posse modules. | ||
|
||
``` | ||
curl -sL https://raw.githubusercontent.com/cloudposse/terraform-null-label/master/exports/context.tf -o context.tf | ||
``` | ||
|
||
Modules should access the whole context as `module.this.context` to get the input variables with nulls for defaults, for example `context = module.this.context`, and access individual variables as `module.this.<var>`, with final values filled in. | ||
### Can I pay for support? | ||
|
||
Yes, we offer paid support via [GitHub Sponsorships](https://github.com/sponsors/cloudposse). | ||
|
||
<iframe src="https://github.com/sponsors/cloudposse/card" title="Sponsor Cloud Posse" height="225" width="600" style={{border: 0}}></iframe> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: Atmos Components | ||
sidebar_label: Atmos Components | ||
description: Atmos Components | ||
sidebar_position: 0 | ||
--- | ||
|
||
This is a collection of reusable Atmos Components. | ||
|
||
## Introduction | ||
|
||
In this library you'll find real-world examples of how we've implemented reusable Atmos Components. |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: Terraform Modules | ||
sidebar_label: Terraform Modules | ||
description: Terraform Modules | ||
sidebar_position: 0 | ||
--- | ||
|
||
This is a collection of reusable Terraform Modules. | ||
|
||
## Introduction | ||
|
||
In this library you'll find real-world examples of how we've implemented reusable Terraform Modules. |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
26 changes: 9 additions & 17 deletions
26
...nts/design-decisions/decide-on-aws-account-flavors-and-organizational-units.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletions
4
docs/layers/accounts/design-decisions/decide-on-aws-organization-strategy.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 6 additions & 2 deletions
8
docs/layers/accounts/design-decisions/decide-on-aws-support.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletions
4
...s/accounts/design-decisions/decide-on-email-address-format-for-aws-accounts.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 4 additions & 2 deletions
6
...yers/accounts/design-decisions/decide-on-mfa-solution-for-aws-root-accounts.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 4 additions & 2 deletions
6
...rs/accounts/design-decisions/decide-on-terraform-state-backend-architecture.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.