Project

General

Profile

Actions

Bug #9253

closed

Cleanup node properties documentation

Added by Jonathan CLARKE over 7 years ago. Updated over 7 years ago.

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

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 1 (0 open1 closed)

Bug #9466: Broken doc buildReleasedBenoît PECCATTE2016-10-20Actions

Related issues 1 (0 open1 closed)

Related to Rudder - User story #9152: Document node properties usageReleasedFrançois ARMAND2016-09-28Actions
Actions #1

Updated by Jonathan CLARKE over 7 years ago

Actions #2

Updated by Jonathan CLARKE over 7 years ago

  • Status changed from New to In progress
Actions #4

Updated by Jonathan CLARKE over 7 years 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
Actions #5

Updated by Vincent MEMBRÉ over 7 years ago

  • Target version changed from 3.1.16 to 3.1.17
Actions #6

Updated by Jonathan CLARKE over 7 years ago

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

Updated by Vincent MEMBRÉ over 7 years 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.

Actions

Also available in: Atom PDF