Implement several documentation improvements to the Agent (for the Buildkite Docs). #3043
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
gilesgas
commented
Oct 17, 2024
gilesgas
commented
Oct 17, 2024
clicommand/redactor_add.go
Outdated
Comment on lines
57
to
74
| Description: `Usage: | ||
|
|
||
| buildkite-agent redactor add [options...] | ||
|
|
||
| Description: | ||
|
|
||
| This command may be used to parse a file for values to redact from a | ||
| running job's log output. If you dynamically fetch secrets during a job, | ||
| it is recommended that you use this command to ensure they will be | ||
| redacted from subsequent logs. Secrets fetched with the builtin | ||
| ′secret get′ command do not require the use of this command, they will | ||
| be redacted automatically. | ||
|
|
||
| Example: | ||
|
|
||
| $ buildkite-agent redactor add ... | ||
|
|
||
| Redacts something.`, |
There was a problem hiding this comment.
Hello @wolfeidau ,
Could you (or would you know anyone who could) please provide an example of how this command is used? Just a typical example using some of the options would be great, and then I can provide a better explanation than what's currently provided in the agent.
There was a problem hiding this comment.
FYI, I fixed the spacing in the Description section only, which is why this comment appears outdated, but it's actually not.
|
The redactor docs will look like this after the merge and release of this PR:
|
DrJosh9000
reviewed
Oct 29, 2024
DrJosh9000
approved these changes
Oct 29, 2024
Co-authored-by: Josh Deprez <jd@buildkite.com>
This was referenced Oct 29, 2024
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
This PR addresses several docs improvements:
Context
The purpose of this PR is to address some long-standing issues with the Buildkite Docs that can only be addressed through the Agent codebase.
Changes
Testing
go test ./...). Buildkite employees may check this if the pipeline has run automatically.go fmt ./...)