fix: allow lower level subcommands #439
Merged
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
Signed-off-by: Terry Howe <[email protected]>
TerryHowe
requested review from
asmitbm,
FeynmanZhou,
sajayantony,
shizhMSFT,
SteveLasker and
vsoch
as code owners
Signed-off-by: Terry Howe <[email protected]>
FeynmanZhou
approved these changes
Dec 13, 2024
There was a problem hiding this comment.
LGTM. It does solve the issue. Now the subcommand pages in v1.3.0-beta.1 can be displayed:
oras manifest index create: https://deploy-preview-438--oras-project.netlify.app/docs/1.3.0-beta.1/commands/oras_manifest_index_createoras manifest index update: https://deploy-preview-438--oras-project.netlify.app/docs/1.3.0-beta.1/commands/oras_manifest_index_update
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.
The current command document generator only does two levels of commands. The introduction of
oras manifest index createis three levels. While this PR is a bit tough to look at, the actual code is a lot easier to look at.list_command.shinto a shell script that can be run and tested by itself for example./tools/list_command manifest indexorascommand so it doesn't need to be passed aroundsubcommands.shthat either prints the command or iterates through the subcommands which can be run for example./tools/subcommands.sh manifest ./versioned_docs/version-1.3.0-beta.1/commands