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

Feat/manpage #1838

Draft
wants to merge 2 commits into
base: staging
Choose a base branch
from
Draft

Conversation

ajinkyagawali1
Copy link

@ajinkyagawali1 ajinkyagawali1 commented Aug 9, 2024

fixes #1704

Prerequisite checklist

  • Read the contribution guidelines regarding submitting new changes to the project;
  • Tested your changes against relevant architectures and platforms;
  • Ran make fmt on your commit series before opening this PR;
  • Updated relevant documentation.

Description of changes

Added a man page for the Kraft CLI based on the kraft --help option. Also modified the installer script to install the man page on Linux Systems.

ajinkyagawali1 and others added 2 commits August 9, 2024 17:23
Added Man page for Linux systems and modified installer script to install them
@nderjung
Copy link
Member

Hi @ajinkyagawali1, thanks for your contribution!

I recommend having a look at the gendocs tool we have internally which currently generates documentation pages in markdown format.

I fear with your solution that this becomes difficult to maintain since it is a static representation of the main help screen as of today.

Please re-review the #1704 as it has the requirements for solving the issue which is to modify this program to output in valid man-page format. You can use cobra's man_docs.go (godoc) program for reference utility methods.

@nderjung nderjung marked this pull request as draft August 12, 2024 07:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add man pages for kraftkit
2 participants