Project

General

Profile

Actions

User story #6659

closed

Man pages for the rudder command

Added by Alexis Mousset almost 9 years ago. Updated over 8 years ago.

Status:
Released
Priority:
N/A
Category:
Agent
Target version:
UX impact:
Suggestion strength:
User visibility:
Effort required:
Name check:
Fix check:
Regression:

Description

Man pages could be useful, especially to provide more information about the commands, explain exactly when to use them, warn about their effects, give examples, etc.

We could also generate html from these man pages, and integrate the rudder command into the online documentation.

This more detailed doc could be an optional field in the command files comments, like the existing @description.


Subtasks 8 (0 open8 closed)

Bug #6688: Package the rudder man pageReleasedBenoît PECCATTE2015-08-18Actions
Bug #6762: Add a task to the ci to build the rudder man in html and man versionsReleasedBenoît PECCATTE2015-08-18Actions
User story #7111: Build the html version of the rudder man page into the manualReleasedBenoît PECCATTE2015-08-18Actions
Bug #7710: Broken builds due to undefined variableReleasedBenoît PECCATTE2015-12-31Actions
Bug #6689: Man pages for rudder commands introduced in 3.1ReleasedBenoît PECCATTE2015-06-02Actions
Bug #6691: Add support for command options or argumentsReleasedBenoît PECCATTE2015-06-02Actions
Bug #7703: Rudder man page should be in section 8ReleasedBenoît PECCATTE2015-12-30Actions
Bug #7704: Rudder man page should be in section 8ReleasedBenoît PECCATTE2015-12-30Actions
Actions

Also available in: Atom PDF