Adjust cli help output to work better with documentation generation #2317
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
I've adjusted the documentation generation with some new feature. The biggest is that text that is indented by 4 spaces is treated as a code block. So we need to unindent non-code and indent code.
As it's in the docs, we should link to the docs rather than a GitHub issue.
triarius
deleted the
pdp-1505-adjust-the-buildkite-agent-help-text-to-work-with-the-new
branch
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.
I've adjusted the documentation generation with some new features. We need to meet it half way in the agent code base though.
The biggest is that text that is indented by 4 spaces is treated as
a code block. So we need to unindent non-code and indent code.
See buildkite/docs#2406 for more details.
If you check out the code in that PR, compile this version of the agent and run the script
scripts/update-agent-help.sh, it should be a no-op.