ClusterLabs / ClusterLabs/crmsh

Sort Subcommands in Command Reference

Open
#57 1 comment 0 reactions 1 assignee Claimed by @krig View on GitHub
enhancement
Dominant language
Python
Stars
143
Forks
96
Avg merge
2d 6h
Merged PRs (30d)
16

Description

Not sure which order or structure is applied in the [Command Reference](https://github.com/crmsh/crmsh/blob/master/doc/crm.8.adoc#command-reference) section of the manpage.

IMHO, it is a bit hard to find the needed information. :) As such, I would like to suggest the following changes:
- Sort the subcommands in alphabetical order.

The manpage is a reference, so it's natural to list commands and its subcommands in alphabetical order. It's easier to find if you scrolls down.
- Group common subsubcommands like `cd`, `up`, etc. into its own section.

You could name it "Common (Sub-)Commands" or the like.
- Add a short description for the main subcommands.

For example, the section about `cib` could be named: `cib -- CIB Shadow Management`. For consistency reasons, it would makes sense to use the same text as you've used in `crm help`.
Descriptions in subcommands are probably not needed as the names are usually clear enough. However, it helps the reader (and his eyes) a lot to see this (optical) distinction between a subcommand (only one word) and its main command (one word plus a short description).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.