[WIP] doc: add man pages for user commands #557
Draft
Conversation
This file contains 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
Problem: flux-accounting has no support for adding man(1) pages to the project, which is needed for man pages for all of the various flux-accounting commands. Add a man1/ folder to flux-accounting to allow man(1) pages to be added to the repository.
Problem: flux-accounting doesn't have a man(1) entry for flux-account, which has lots of subcommands that could use specific manual pages to describe how to use each subcommand. Add a general flux-account(1) man page entry and list of all the currently available subcommands. Add man(1) entries for all of the DB administration commands, i.e create-db, export-db, and pop-db. Add some of the flagged "mispelled" words in these man pages to the dictionary.
Problem: flux-accounting has no man(1) pages for any of the subcommands that deal with user administration. Add man(1) entries for view-user, add-user, delete-user, and edit-user.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem
flux-accounting has no
man(1)pages for any of the commands that deal with user administration, like adding, editing, or viewing user information.This PR adds
man(1)entries forview-user,add-user,delete-user, andedit-user.(built on top of #538 since that PR adds the infrastructure for adding
manpages for the flux-accounting commands)