-
Notifications
You must be signed in to change notification settings - Fork 79
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
Labels
kind/documentation
Categorizes issue or PR as related to documentation.
priority/backlog
Higher priority than priority/awaiting-more-evidence.
Projects
Comments
This is related to #7 in that documenting the env variables can go in the |
vielmetti
added
the
kind/documentation
Categorizes issue or PR as related to documentation.
label
Apr 6, 2020
nathangoulding
added
the
kind/feature
Categorizes issue or PR as related to a new feature.
label
Jul 21, 2020
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
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.
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.
The text was updated successfully, but these errors were encountered: