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 docs for CLI flags #266

Merged
merged 11 commits into from
Jul 10, 2019
Merged

Conversation

yurishkuro
Copy link
Member

Resolves #250 , replaces #263 and #257

@yurishkuro
Copy link
Member Author

yurishkuro commented Jul 3, 2019

Changes since @lucperkins 's PR #263:

  • flag description is rendered as a separate row, to make the tables more readable (no wrapping of most flags). I also dropped "shortcut" column since we usually don't define those for all flags
  • removed documentation for docs, env, and version commands, as there's not a lot of value in those (we could add them if desired, but the page is already pretty long).
  • created a data/cli/${ver]/config.json that describes which tools the docs should be generated for and which storage options are applicable to each tool. Both the templates and the script that generates YAML files use that config as the main index. Later versions can run with a different config, e.g. if we add new storage options.
  • YAML files generated for all applicable storage types

Strictly speaking, the PR can be merged as is already, as it gives usable docs. But the following could be improved:

Yuri Shkuro added 2 commits July 3, 2019 19:09
- Prefix all flags with `--`, to reflect how they are actually used.

Signed-off-by: Yuri Shkuro <[email protected]>
@yurishkuro
Copy link
Member Author

@pavolloffay @objectiser @jpkrohling do we want to merge this as is? The only real issue is that the right sidebar is partially unusable (but navigation is also available from the top of the page).

@objectiser
Copy link
Contributor

Fine with me. Having the information available is a benefit and formatting can be improved later.

@yurishkuro
Copy link
Member Author

ok, I removed the right sidebar completely, since it's not fully usable, and added some in-page navigation. Need approval to merge.

@yurishkuro yurishkuro changed the title WIP Generate docs for CLI flags Generate docs for CLI flags Jul 10, 2019
@pavolloffay
Copy link
Member

great to see this landing here. Thanks @lucperkins @yurishkuro !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document flags
4 participants