Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: clean up / reorganize Infrastructure documentation #2159

Merged
merged 6 commits into from
Jun 13, 2024

Conversation

angela-tran
Copy link
Member

This PR reorganizes the infrastructure documentation to be friendlier to a new developer.

  • Added an intro section with more context on how to get access
  • Moved up sections that explain the environments and architecture
  • Made some content edits to remove unnecessary detail and use clearer wording

@angela-tran angela-tran self-assigned this Jun 12, 2024
@angela-tran angela-tran requested a review from a team as a code owner June 12, 2024 19:28
@github-actions github-actions bot added documentation [auto] Improvements or additions to documentation infrastructure Terraform, Azure, etc. labels Jun 12, 2024
Copy link

github-actions bot commented Jun 12, 2024

Coverage report

This PR does not seem to contain any modification to coverable code.

Copy link

@angela-tran angela-tran force-pushed the docs/infra-reorg-redo branch from 135ae9f to a461233 Compare June 12, 2024 19:29
@angela-tran
Copy link
Member Author

@lalver1 @thekaveman I opened this new PR to replace #2129. This one has cleaner commits and is hopefully easier to review.

Copy link
Member

@thekaveman thekaveman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general I really like this reorg of the content.

I think some of the sections are too deep though, see my comment below.

docs/deployment/infrastructure.md Outdated Show resolved Hide resolved
Copy link
Member

@lalver1 lalver1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks really good @angela-tran, and it's super useful for a new developer 👍

@angela-tran angela-tran requested a review from thekaveman June 12, 2024 22:59
Copy link
Member

@thekaveman thekaveman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝

@thekaveman thekaveman marked this pull request as draft June 13, 2024 18:00
@thekaveman thekaveman marked this pull request as ready for review June 13, 2024 18:02
@thekaveman thekaveman force-pushed the docs/infra-reorg-redo branch from f4d2d5b to 232a7f9 Compare June 13, 2024 18:49
@angela-tran angela-tran merged commit 64db833 into dev Jun 13, 2024
14 checks passed
@angela-tran angela-tran deleted the docs/infra-reorg-redo branch June 13, 2024 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation [auto] Improvements or additions to documentation infrastructure Terraform, Azure, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants