Fix yamldocs generator to accomodate nested subcommands#2390
Merged
silvin-lubecki merged 3 commits intodocker:masterfrom Mar 17, 2020
Merged
Fix yamldocs generator to accomodate nested subcommands#2390silvin-lubecki merged 3 commits intodocker:masterfrom
silvin-lubecki merged 3 commits intodocker:masterfrom
Conversation
These files were intended to document the `swarm join-token` and `swarm unlock-key` subcommands, but were incorrectly using an underscore instead of a hyphen (`-`). As a result, the examples were not picked up by the yamldocs generator. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Member
Author
|
looking into some changes in the generated docs; don't merge yet |
The script was written to only take subcommands at the first and second level
into account, but failed to find the Markdown files for extended descriptions of
subcommands at the third level, such as `docker trust key generate`, and
`docker trust key load`:
WARN: /go/src/github.com/docker/cli/docs/reference/commandline/key_generate.md does not exist, skipping
WARN: /go/src/github.com/docker/cli/docs/reference/commandline/key_load.md does not exist, skipping
WARN: /go/src/github.com/docker/cli/docs/reference/commandline/signer_add.md does not exist, skipping
WARN: /go/src/github.com/docker/cli/docs/reference/commandline/signer_remove.md does not exist, skipping
This patch updates the script to accomodate subcommands that are more deeply
nested. While at it, some minor cleaning and linting issues were also addressed.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
If the markdown contains trailing spaces, or has tabs included, the YAML generator uses a compact format for the text (using `\n` and `\t`, instead of plain newlines). The compact format makes it difficult to review changes in the yaml docs when vendoring in the documentation repository. This patch: - removes trailing whitespace - replaces tabs for spaces - fixes some minor formatting and markdown issues Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Member
Author
fixed 👍 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The script was written to only take subcommands at the first and second level
into account, but failed to find the Markdown files for extended descriptions of
subcommands at the third level, such as
docker trust key generate, anddocker trust key load:This patch updates the script to accomodate subcommands that are more deeply
nested. While at it, some minor cleaning and linting issues were also addressed.
Some files were named incorrectly, which has also been fixed in this PR
- Description for the changelog
ping @silvin-lubecki PTAL