Skip to content
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

Generate user cli doc #18144

Merged
merged 13 commits into from
Sep 19, 2023
Merged

Generate user cli doc #18144

merged 13 commits into from
Sep 19, 2023

Conversation

Xenorith
Copy link
Contributor

  • Add a new CLI command that iterates through the command tree and generates a markdown file based on each command's definition and description
  • Migrate all the content in the previous User-CLI.md into the corresponding commands in golang code, mainly updating their Long and Examples fields
  • Run bin/alluxio generate user-cli to write the generated content directly into docs/en/operation/User-CLI.md

@Xenorith Xenorith requested a review from Zijian-Zhu September 14, 2023 07:31
@Xenorith
Copy link
Contributor Author

@Zijian-Zhu the main content to review is in the first commit: 3b7604d

all other changes are to migrate the content of User-CLI.md to their respective golang commands.
note that the User-CLI.md file is now 100% generated, similar to the csv and yaml files in docs/_data/generated/. but since the generated content is in markdown, i could not follow the pattern of generating the file in the generated/ directory and embed the contents.

this file also faces the similar maintenance problem as the generated files. if someone changes the CLI commands, it will cause the User-CLI.md file to be out of date. someone needs to manually run the bin/alluxio generate user-cli command to regenerate the file and commit the diff.

@Xenorith Xenorith added the type-docs Documentation Defects label Sep 19, 2023
@Xenorith
Copy link
Contributor Author

alluxio-bot, merge this please

@alluxio-bot alluxio-bot merged commit dd863fe into Alluxio:main Sep 19, 2023
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type-docs Documentation Defects
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants