Project

General

Profile

User story #6659

Man pages for the rudder command

Added by Alexis MOUSSET almost 6 years ago. Updated about 5 years ago.

Status:
Released
Priority:
N/A
Category:
Agent
Target version:
Suggestion strength:
User visibility:
Effort required:

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

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
#1

Updated by Alexis MOUSSET almost 6 years ago

  • Assignee set to Alexis MOUSSET
  • Target version changed from Ideas (not version specific) to 3.0.6
#2

Updated by Alexis MOUSSET almost 6 years ago

  • Status changed from New to In progress
#3

Updated by Alexis MOUSSET over 5 years ago

  • Status changed from In progress to Pending technical review
  • Assignee changed from Alexis MOUSSET to Benoît PECCATTE
  • Pull Request set to https://github.com/Normation/rudder-agent/pull/13/files
#4

Updated by Benoît PECCATTE over 5 years ago

  • Status changed from Pending technical review to Discussion
  • Assignee changed from Benoît PECCATTE to Alexis MOUSSET
#5

Updated by Alexis MOUSSET over 5 years ago

  • Status changed from Discussion to Pending technical review
  • Assignee changed from Alexis MOUSSET to Benoît PECCATTE
#6

Updated by Alexis MOUSSET over 5 years ago

  • Status changed from Pending technical review to Pending release
  • % Done changed from 0 to 100
#8

Updated by Vincent MEMBRÉ over 5 years ago

  • Status changed from Pending release to Released

This bug has been fixed in Rudder 3.0.6 and 3.1.0~rc1 which were released on the 16th June 2015.

Also available in: Atom PDF