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

Add man pages for kraftkit #1704

Open
2 tasks
thass0 opened this issue Jun 6, 2024 · 7 comments · May be fixed by #1838
Open
2 tasks

Add man pages for kraftkit #1704

thass0 opened this issue Jun 6, 2024 · 7 comments · May be fixed by #1838
Assignees
Labels
good-first-issue Good for newcomers kind/enhancement New feature or request priority/low Nice to have issues thatare not urgent, but can be nagging.

Comments

@thass0
Copy link
Member

thass0 commented Jun 6, 2024

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:

  • generate man pages from the CLI
  • modify the kraftkit installer scripts to make them install the man pages on the user's system (and maybe ask them if they want that)

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

@thass0 thass0 added the kind/enhancement New feature or request label Jun 6, 2024
@nderjung nderjung added the good-first-issue Good for newcomers label Jun 7, 2024
@2k4sm
Copy link

2k4sm commented Jul 22, 2024

Hey @thass0 and @nderjung i would like to work on this issue can you assign me on this.

@2k4sm
Copy link

2k4sm commented Jul 25, 2024

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.

@thass0
Copy link
Member Author

thass0 commented Jul 25, 2024

I'm not aware of anybody else working on this so feel free go ahead.

@ajinkyagawali1
Copy link

Hi, noticing that this issue is still open, I am interested to contribute.
I also have a prototype of the man page ready.

@thass0
Copy link
Member Author

thass0 commented Aug 7, 2024

@ajinkyagawali1 Sounds cool! @2k4sm are you still working on this?

@ajinkyagawali1
Copy link

Should I open a pull request.

@ajinkyagawali1 ajinkyagawali1 linked a pull request Aug 9, 2024 that will close this issue
4 tasks
@craciunoiuc craciunoiuc added the priority/low Nice to have issues thatare not urgent, but can be nagging. label Aug 26, 2024
@teodoradriann
Copy link

I'm working on this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good-first-issue Good for newcomers kind/enhancement New feature or request priority/low Nice to have issues thatare not urgent, but can be nagging.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants