Auto generate CLI docs for documentation repo #685
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
<!--- Note to EXTERNAL Contributors --> <!-- Thanks for opening a PR! If it is a significant code change, please **make sure there is an open issue** for this. We work best with you when we have accepted the idea first before you code. --> <!--- For ALL Contributors 👇 --> <!-- Describe what has changed in this PR --> Created a new `string-enum[]` type <!-- Tell your future self why have you made these changes --> Command option behavior already exists, there just wasn't a specific type for this yet. <!--- add/delete as needed ---> 1. Closes temporalio#670 2. How was this tested: <!--- Please describe how you tested your changes/how we can test them --> 3. Any docs updates needed? <!--- update README if applicable or point out where to update docs.temporal.io --> --------- Co-authored-by: David Reiss <[email protected]>
cretz
reviewed
Oct 3, 2024
cretz
approved these changes
Oct 4, 2024
|
|
||
| go run ./temporalcli/internal/cmd/gen-docs | ||
|
|
||
| This will auto-generate a new set of docs to `temporalcli/docs/`. If a new root command is added, a new file will be automatically generated, like `temporal activity` and `activity.mdx`. |
There was a problem hiding this comment.
You could also accept the dir to write to as a CLI arg to this tool, but up to you
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.
What was changed
Auto generate all of the *.mdx files present in the current documentation repo. index.mdx is not auto-generated
IMPORTANT: The generated files are not yet being consumed anywhere. A future PR will auto-publish a PR into the docs repo whenever there is a docs related change.
Added a field in the YML to indicate doc-specific information, like SEO related keywords and descriptions.
Removed
cmd-options.cdxand print each command option description inline in each file instead.temporalio/documentation#3122 removes all references to this file from the documentation side.
Why?
This is in a larger effort to have the CLI be the source of truth for docs, and have the documentation auto-ingest any CLI changes, keeping all information in sync.
This is the first step to this goal, there are a number of follow up tasks that I wanted to split up from this PR:
Checklist
For now, docs will not be updated. There will be a future PR that auto-creates a PR into the documentation repo with any updates.