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 documentation for build secrets #156

Merged
merged 1 commit into from
Sep 12, 2024
Merged

Conversation

matt-bernhardt
Copy link
Member

@matt-bernhardt matt-bernhardt commented Sep 11, 2024

This takes all the information from the readme that deal with build secrets - both managed by Terminus and by Github - and pulls them out to a new How To article that focuses only on managing build secrets. Other secrets, like application secrets or ENV values, are left in place - which is something of a side effect. This isn't ideal, but the remedy would be a much larger refactor of our readme into many more How To articles, which is beyond my current bandwidth.

Developer

Stylesheets

  • Any theme or plugin whose stylesheets have changed has had its version
    string incremented.

Secrets

  • All new secrets have been added to Pantheon tiers
  • Relevant secrets have been updated in Github Actions
  • All new secrets documented in README
  • No secret values are affected

Documentation

  • Project documentation has been updated
  • No documentation changes are needed

Accessibility

  • ANDI or Wave has been run in accordance to
    our guide and
    all issues introduced by these changes have been resolved or opened as new
    issues (link to those issues in the Pull Request details above)
  • There are no UI updates to this change

Stakeholder approval

  • Stakeholder approval has been confirmed
  • Stakeholder approval is not needed
  • Stakeholder is the code reviewer

Dependencies

NO dependencies are updated

Code Reviewer

  • The commit message is clear and follows our guidelines
    (not just this pull request message)
  • The changes have been verified
  • The documentation has been updated or is unnecessary
  • New dependencies are appropriate or there were no changes

This combines a few areas of the current readme into a separate how-to article, and tries to explain everything more clearly.
Copy link
Member

@JPrevost JPrevost left a comment

Choose a reason for hiding this comment

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

Thank you!

@matt-bernhardt matt-bernhardt merged commit a12afe5 into master Sep 12, 2024
3 checks passed
@matt-bernhardt matt-bernhardt deleted the build-documentation branch September 12, 2024 14:12
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.

2 participants