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

Update CI/CD docs #1470

Merged
merged 3 commits into from
May 1, 2023
Merged

Update CI/CD docs #1470

merged 3 commits into from
May 1, 2023

Conversation

bourgeoisor
Copy link
Member

@bourgeoisor bourgeoisor commented Apr 27, 2023

This PR:

  • Updates the CI/CD pipeline doc and moves it to the docs/ directory (before / after)
    • Expanded and cleaned up the context
    • Cleaned up the steps
  • Updates the root README and move it back to the root (before, after)
    • Fixed typo in the quickstart (stray --region)
    • Expanded the "docs" section at the bottom
  • Creates a "directory" of docs as a README of docs/ (here)
  • Creates a "directory" of IaC as a README of iac/ (here)
  • Hardcodes the TF state bucket name to simplify the set-up process

Because of the same-name files that moved around, the "GitHub diff" is moot. See above the before / after links as well as "what" changed, which can help with the review.

@bourgeoisor bourgeoisor requested review from a team and yoshi-approver as code owners April 27, 2023 19:36
Copy link

@minherz minherz left a comment

Choose a reason for hiding this comment

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

lgtm. I did not validate the content and/or links.

README.md Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
@bourgeoisor bourgeoisor merged commit 2c6c0af into main May 1, 2023
6 checks passed
@bourgeoisor bourgeoisor deleted the issue-update-tf-readme branch May 1, 2023 19:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants