Add entry in PR description asking Pull Requesters to document any new commands they add #2688
+69
−1
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
…w commands they add
triarius
reviewed
Mar 12, 2024
There was a problem hiding this comment.
The docs repo is public too yeah? I think this document belongs there as most of the commands assume the working directory is a docs repo.
1. Clone or change direcotry to the docs repo: https://github.com/buildkite/docs.git
2. Follow the instructions in https://github.com/buildkite/docs?tab=readme-ov-file#agent
I suggested putting it in an agent section in the README as there is no docs directory in the docs repo for documentation on the documentation! You could create one if you want. I think it's a good precedent to set.
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.
Description
The current (internal) guidance is that when a buildkite employee makes a new release of the agent, they open a PR against the docs that includes updates in CLI reference there, which is kinda-sorta autogenerated from the helptexts that we write for commands in this repo.
the issue with this process is that the process for adding a new page for a new agent cli command is a bit involved, and often it leaves the person who made the release in charge of adding docs for a command they didn't write, which is a minor pain.
this PR adds another couple of checkboxes to the PR description (the one i'm typing in right now!) asking that if the user has added a command, that they open a PR against the docs repo. i also added a checkbox for "updated the readme as necessary", because the other checkbox was looking lonely on its own
Context
buildkite/docs#2710
Testing
go test ./...). Buildkite employees may check this if the pipeline has run automatically.go fmt ./...)