Project

General

Profile

Bug #9253

Cleanup node properties documentation

Added by Jonathan CLARKE about 1 year ago. Updated about 1 year ago.

Status:
Released
Priority:
N/A
Category:
Documentation
Target version:
Target version (plugin):
Severity:
User visibility:
Effort required:
Priority:

Description

#9152 introduces documentation for node properties. There is room for improvement in several areas:

  • English. Some words are hanging, like "It’s also a perfect to provide..."
  • Product name: Rudder has a capital.
  • Examples. Several are not real-world examples, which should always be avoided in our documentation (like "a simple value").

Subtasks

Bug #9466: Broken doc buildReleasedBenoît PECCATTE


Related issues

Related to Rudder - User story #9152: Document node properties usage Released 2016-09-28

Associated revisions

Revision 19145305
Added by Jonathan CLARKE about 1 year ago

Fixes #9253: Cleanup node properties documentation

Revision 8f775bdf
Added by Jonathan CLARKE about 1 year ago

Fixes #9253: Cleanup node properties documentation

History

#1 Updated by Jonathan CLARKE about 1 year ago

#2 Updated by Jonathan CLARKE about 1 year ago

  • Status changed from New to In progress

#4 Updated by Jonathan CLARKE about 1 year ago

  • Status changed from In progress to Pending technical review
  • Assignee changed from Jonathan CLARKE to François ARMAND
  • Pull Request set to https://github.com/Normation/rudder-doc/pull/235

#5 Updated by Vincent MEMBRÉ about 1 year ago

  • Target version changed from 3.1.16 to 3.1.17

#6 Updated by Jonathan CLARKE about 1 year ago

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

#7 Updated by Vincent MEMBRÉ about 1 year ago

  • Status changed from Pending release to Released

This bug has been fixed in Rudder 4.0.1, 3.1.16 and 3.2.10 which were released today.

Also available in: Atom PDF