Security documentation improvements. #2837
Merged
Conversation
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
github-actions
bot
added
the
pipelines
|
Preview URL: https://2837--bk-docs-preview.netlify.app |
…anti-pattern' references.
github-actions
bot
added
test-analytics
…nnings of overview, and restructure 'managing secrets' a tad to make it clearer what this page is for.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A summary of changes implemented:
Original Managing (pipeline) secrets page-related changes (since the current content organisation on this page is a little messy and unclear):
Add a new Secrets section with a Secrets overview page (preview here) to contain all new secrets-related content (in child pages) for Buildkite Pipelines. Provide overview that this section contains details on how to manage secrets in Buildkite Pipelines for both Buildkite hosted and self-hosted agent setups. Add links to all child pages with brief, relevant explanations.
Move current anti-pattern content from here onwards on the original Managing (pipeline) secrets page onto its own Risk considerations page (preview here), and modify its headings' intro sections to add more context to the page and each revised heading. (That is, remove the term 'anti-pattern' from each heading as it's jargon and adds no value now that they appear on their own page.)
Make the Managing (pipeline) secrets page a child of the new Secrets section and update its URL path to match its sibling pages (preview here).
Add intro sections to the relevant top-half sections of the Managing (pipeline) secrets page (preview here) to clarify which sections of this page are relevant to Buildkite hosted agents, self-hosted agents, or both.
Move the original Buildkite secrets page from its Hosted agents section to this new Security > Secrets section as this feature is applicable to both Buildkite hosted agents and self-hosted agents. (I.e. It doesn't make sense and is confusing housing this page within the Hosted agents section of the docs.) Therefore, The Buildkite secrets page's URL path is updated to match its sibling pages (preview here).
As part of changing URLs, URL redirects were also implemented, as well as page links to this content from elsewhere throughout the Buildkite Docs, which the muffet job would have picked up.
There is a 2nd part to this work which is being covered in a separate PR (#2878).