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

man page for boots #9

Open
vielmetti opened this issue Apr 3, 2020 · 2 comments
Open

man page for boots #9

vielmetti opened this issue Apr 3, 2020 · 2 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation. priority/backlog Higher priority than priority/awaiting-more-evidence.
Projects

Comments

@vielmetti
Copy link

Provide a man page for boots, so that a sysadmin looking for help on command line options, flags, and other issues has a single place to go.

Suggest that the man page be written with markdown + pandoc, as described in this tutorial - no particular need to write raw troff. The file https://github.com/eddieantonio/license/blob/master/license.1.md is an example written this way.

@vielmetti
Copy link
Author

This is related to #7 in that documenting the env variables can go in the ENVIRONMENT section of the man page.

@vielmetti vielmetti added the kind/documentation Categorizes issue or PR as related to documentation. label Apr 6, 2020
@nathangoulding nathangoulding added this to Requests in Issues List Apr 14, 2020
@nathangoulding nathangoulding added the kind/feature Categorizes issue or PR as related to a new feature. label Jul 21, 2020
@splaspood
Copy link
Contributor

It seems that we should have consistent standards for CLI/ENV arguments and the documenting thereof. As much as I have a fondness for man, I wonder if that's really the place where most people will go to find this documentation given today's common deployment methods and use cases.

@tstromberg tstromberg added priority/backlog Higher priority than priority/awaiting-more-evidence. and removed kind/feature Categorizes issue or PR as related to a new feature. labels Aug 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. priority/backlog Higher priority than priority/awaiting-more-evidence.
Projects
No open projects
Issues List
  
Requests
Development

No branches or pull requests

4 participants