Add hidden docs command for man page and markdown generation#160
Merged
Add hidden docs command for man page and markdown generation#160
Conversation
silv-io
requested review from
anisaoshafi and
carole-lavillonniere
as code owners
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
lstk had no man pages or generated documentation. Users installing via Homebrew or release archives couldn't run
man lstkto get help.Changes
lstk docssubcommand with--format(man/markdown) and--dirflags usingcobra/docgo run . docs, archives includemanpages/*)completions/andmanpages/to.gitignoreThe
docscommand is hidden (not shown in--help) following the same pattern as Helm'shelm docscommand. Cobra automatically excludes it from the generated documentation.Tests
4 new integration tests:
.1files.mdfiles--helpoutputRelated