-
Notifications
You must be signed in to change notification settings - Fork 64
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
Add man pages for kraftkit #1704
Comments
Hey @nderjung as i haven't heard anything from you so i will be moving forward to start working on this issue. I will be creating a draft PR as soon as i make some progress. |
I'm not aware of anybody else working on this so feel free go ahead. |
Hi, noticing that this issue is still open, I am interested to contribute. |
@ajinkyagawali1 Sounds cool! @2k4sm are you still working on this? |
Should I open a pull request. |
I'm working on this |
Feature request summary
On Unix-like systems, virtually all core applications and many system features have "man pages" that hold relevant documentation. I would be cool if kraftkit also had such a man pages. This way, one could run
man kraft
locally to read up on kraftkit documentation.Kraftkit uses cobra for it's CLI, and cobra can auto-generate documentation based on the CLI. This includes generating man pages. In addition to that, there is the gendocs tool in krafkit that generates CLI docs in a different format than cobra would. The output of the gendocs tool is used verbatim in the kraftkit and Unikraft online docs. That's why the format is different.
To add man pages to kraftkit:
Describe alternatives
There are web docs and the
kraft
command itself can display help information.Related architectures
None
Related platforms
None
Additional context
No response
The text was updated successfully, but these errors were encountered: