-
Notifications
You must be signed in to change notification settings - Fork 42
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
Update nexus commands.yml for docs gen #693
Conversation
Signed-off-by: Phil Prasek <[email protected]>
Signed-off-by: Phil Prasek <[email protected]>
Signed-off-by: Phil Prasek <[email protected]>
Signed-off-by: Phil Prasek <[email protected]>
temporalcli/commandsgen/commands.yml
Outdated
@@ -3035,6 +3000,7 @@ option-sets: | |||
env: TEMPORAL_CODEC_AUTH | |||
|
|||
- name: overlap-policy | |||
description: Schedule commands |
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.
It doesn't seem right that this is the same description for overlap-policy
, schedule-id
, and schedule-configuration
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.
The option-set description
is a new field added for option-set
usages in the the combined approach, where it would show up as follows:
Until the the combined approach lands this field is not used.
Note the main purpose is to to see where divergent option descriptions are used (in commands or option-sets) in the generated cmd-options.mdx
that collate on the various option descriptions under a given option name across command and option set usages.
After discussion with @yuandrew it's likely these would just be used for linting rules as we're moving away from cmd-options.mdx
as it doesn't scale very well.
Given that will remove all these option-set descriptions for now and we can revisit later.
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.
Ah, that's what you were going for. Sorry I was so confused. Thanks for the visual aid.
temporalcli/commandsgen/commands.yml
Outdated
required: true | ||
|
||
- name: nexus-endpoint-config | ||
description: Nexus endpoint commands |
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'm not sure I see the benefit of option-set descriptions. They don't seem to add that much more information than what someone can glean from the option-set name
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.
see comment above, it was for cmd-options.mdx
generation where we wanted to emit a description of option usage:
- command usage or
- option-set usage
wanted the usage site be human friendly vs. the option-name. another option would be to find all commands that use the option-set and add those so all option usages are commands, but think removing description
for now is more expedient, so will do that.
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.
Sounds good to me. Suggest a quick case-sensitive scan to inspect endpoint lowercase/uppercase.
Signed-off-by: Phil Prasek <[email protected]>
feedback has been incorporated, think we're good to go. |
Signed-off-by: Phil Prasek <[email protected]>
Signed-off-by: Phil Prasek <[email protected]>
Signed-off-by: Phil Prasek <[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.
LGTM apart from one comment. Feel free to merge once addressed, no need to re-review.
Signed-off-by: Phil Prasek <[email protected]>
What was changed
commands.yml
to address feedback on:See this branch for the combined approach with all PRs merged in.
Why?
To create CLI docs for Nexus.
Checklist
go run ./temporalcli/internal/cmd/gen-docs
yarn start
Ran
go test ./...
Tested locally with: