Buildkite Packages docs - updates for the public beta release #2803
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
…s docs pages and how they are presented in the intro material to the docs.
|
Preview URL: https://2803--bk-docs-preview.netlify.app |
github-actions
bot
added
the
pipelines
github-actions
bot
added
the
test-analytics
github-actions
bot
removed
the
test-analytics
Merged
…s and reuse more of the shared pipelines content.
github-actions
bot
added
the
test-analytics
… teams permissions content.
…doc-updates # Conflicts: # pages/team_management/permissions.md
…the equivalent pages in Pipelines and Test Analytics.
…for pipelines' and improve access instructions.
…registry creation processes.
DanielOaks
reviewed
May 28, 2024
| - Python (PyPI) | ||
| - RPM (Fedora and RHEL) | ||
| - RedHat (RPM) |
There was a problem hiding this comment.
It could be worth mentioning Fedora here since that feels like the more well-known name. e.g. maybe RedHat and Fedora (RPM)
| - Ruby (RubyGems gem) | ||
| - Alpine (apk) | ||
| - Container (Docker) images | ||
| - Debian (and Ubuntu) |
There was a problem hiding this comment.
Hmm, most of these have the package type in the parentheses. Maybe something like Debian and Ubuntu (DEB) could be more consistent?
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.
Things done so far:
Update the order of the specific packages docs pages to match the UI and refactor how they are presented in the Overview (preview here) and Manage registries (preview here) pages to how they are presented in the UI (mostly).
Include a small section on audit logging to the end of the Manage registries page (preview here) and update the main Audit log page with Packages events (preview here).
Add Access control page (preview here) for the Packages docs, based loosely off the equivalent for Test Analytics, as well as substantially update the following pages to improve their content, which was somewhat confusing due to their brevity and the fact that the main Pipelines equivalent page required many changes to accommodate the doc updates for the Packages permissions. Therefore, these pages (preview links only) were also given significant updates:
Add new sections to the Access controls (entitled Manage an agent's access to registries) and Manage registries (entitled Configure a registry's OIDC policy) pages for OIDC policy handling.
Add Container page (preview here) for newly supported Container (Docker) registries.