-
Notifications
You must be signed in to change notification settings - Fork 38
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Enhanced docs gen to more closely match existing docs #692
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Phil Prasek <[email protected]>
Signed-off-by: Phil Prasek <[email protected]>
for _, options := range w.optionsStack { | ||
allOptions = append(allOptions, options...) | ||
} | ||
if len(c.Children) == 0 { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great improvement here! The old code fails to handle a few edge cases with more complex subcommands.
How are Parent
and Children
used? I only see Children
being used to check if len(c.Children) == 0 {
, and I don't see the Parent
information used anywhere. If that's the case, I feel like a simpler approach would be to keep a IsLeafCommand
from enrich.go
and use that for this condition here
## What was changed - Updated `commands.yml` to address feedback on temporalio/documentation#3149 (comment) - Intended for use with the following, but also is fine to merge standalone - #691 - #692 See this branch for [the combined approach](https://github.com/prasek/temporal-cli/tree/cli-docs-gen-all) with all PRs merged in. ## Why? To create CLI docs for Nexus. ## Checklist 1. How was this tested: - `go run ./temporalcli/internal/cmd/gen-docs ` - also tested with [the combined appraoch](https://github.com/prasek/temporal-cli/tree/cli-docs-gen-all) - copied generated docs (or subset) to temporalio/documentation - `yarn start` - verified via http://localhost:3000/ Ran `go test ./...` Tested locally with: ``` go run ./cmd/temporal operator nexus endpoint create --name myendpoint --target-namespace my-target-namespace --target-task-queue my-handler-task-queue --description '## Sales Services Workflow'\''s to support Customer-to-Order generation. ## other stuff ' ``` 2. Any docs updates needed? - overall docs gen needs more alignment with the existing docs, but that is out of scope for these Nexus changes - will update temporalio/documentation#3149 with cherry picked generated content from [the combined approach](https://github.com/prasek/temporal-cli/tree/cli-docs-gen-all). --------- Signed-off-by: Phil Prasek <[email protected]> Signed-off-by: Josh Berry <[email protected]>
Signed-off-by: Phil Prasek <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this separate concept needs to exist. Just put inside parse or put inside docs.
What was changed
cmd-options.mdx
with collated on option descriptioncmd-options.mdx
See this branch for the combined approach with follow-on PRs merged in.
Note: longer term would recommend moving away from
cmd-options.mdx
and to an inline options model similar to howtcld
docs works, as some option names likename
,build-id
, andyes
have lots of overlapping definitions and some are specific to command usage.Why?
Needed updated
operator.mdx
andcmd-options.mdx
output for Nexus docs and wanted to use docs gen.Checklist
go run ./temporalcli/internal/cmd/gen-docs
yarn start