search

habitat-sh / habitat

Modern applications with built-in automation
https://www.habitat.sh
Apache License 2.0
2.6k stars 315 forks source link

Website - missing doc entry for `hab studio version` #7261

Open james-stocks opened 4 years ago

james-stocks commented 4 years ago

This command is listed but has no description https://www.habitat.sh/docs/habitat-cli/#hab-studio-version

(this might seem a bit stupid to want docs for this command if it's just the version command, but I wanted to check because https://github.com/habitat-sh/core-plans/pull/3154 seems to effect change by calling this command)

Aha! Link: https://chef.aha.io/features/APPDL-107

christophermaier commented 4 years ago

This is a result of how our CLI documentation generation code expects things to be formatted. That, and the fact that the hab studio version doesn't actually have on-line help text like everything else does :sweat_smile:

You're right that there's not really much to document, but the difference is highlighted by how the help text is presented on the website, so it's worth fixing. Should be pretty straightforward to add a documentation function call along the lines of print_build_help and others.

kagarmoe commented 3 years ago

This is a bug in the code, not in the docs. The CLI docs are generated from the code. If you fix the CLI (make it conform to how it should work) then the documentation will appear through the automation.

stale[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. We value your input and contribution. Please leave a comment if this issue still affects you.