Update nexus commands.yml for docs gen#693
Conversation
Signed-off-by: Phil Prasek <prasek@gmail.com>
Signed-off-by: Phil Prasek <prasek@gmail.com>
Signed-off-by: Phil Prasek <prasek@gmail.com>
temporalcli/commandsgen/commands.yml
Outdated
| env: TEMPORAL_CODEC_AUTH | ||
|
|
||
| - name: overlap-policy | ||
| description: Schedule commands |
There was a problem hiding this comment.
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.
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.
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.
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.
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.
Sounds good to me. Suggest a quick case-sensitive scan to inspect endpoint lowercase/uppercase.
Signed-off-by: Phil Prasek <prasek@gmail.com>
|
feedback has been incorporated, think we're good to go. |
Signed-off-by: Phil Prasek <prasek@gmail.com>
Signed-off-by: Phil Prasek <prasek@gmail.com>
Signed-off-by: Phil Prasek <prasek@gmail.com>
Signed-off-by: Phil Prasek <prasek@gmail.com>
josh-berry
left a comment
There was a problem hiding this comment.
LGTM apart from one comment. Feel free to merge once addressed, no need to re-review.
Signed-off-by: Phil Prasek <prasek@gmail.com>
What was changed
commands.ymlto 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-docsyarn startRan
go test ./...Tested locally with: