Bug #3943: Documentation is missing some level 2 headers - Rudder - Issue Tracker

Actions

Copy link

Bug #3943

closed

Documentation is missing some level 2 headers

Added by Jonathan CLARKE about 11 years ago. Updated over 9 years ago.

Status:

Released

Priority:

1 (highest)

Assignee:

Jonathan CLARKE

Category:

Documentation

Target version:

2.4.9

Pull Request:

https://github.com/Normation/rudder-d...

Severity:

UX impact:

User visibility:

Effort required:

Priority:

Name check:

Fix check:

Regression:

Description

As of version 2.4 (!), rudder-doc chapter 9 has some broken and missing headers. It starts like this:

9. Advanced usage

This chapter describe advanced usage of Rudder. === About Technique upgrades
9.0.1. Initial installation

At the first installation, Rudder will automatically deploy a Technique library in the /var/rudder/configuration-repository/techniques directory.

As you can see, the numbering goes straight from 9 to 9.0.1, a "H2" title is missing. In effect, several are missing. Then the order seems broken too...

Related issues 1 (0 open — 1 closed)

Actions

Copy link

Updated by Jonathan CLARKE about 11 years ago

Assignee changed from Jonathan CLARKE to Nicolas PERRON

Nicolas, can you investigate why this happens please?

If you need pointers as to what titles and order to insert, please collect a list of sub-items and I will happily help you work on a new hierarchy.

Actions

Copy link

Updated by Nicolas PERRON about 11 years ago

Status changed from 8 to Discussion
Assignee changed from Nicolas PERRON to Jonathan CLARKE
% Done changed from 0 to 70

Jonathan CLARKE wrote:

Nicolas, can you investigate why this happens please?

If you need pointers as to what titles and order to insert, please collect a list of sub-items and I will happily help you work on a new hierarchy.

I've found the problem: missing line breaker at the end of the files.

You proposed to reorder the chapter if I show you a list. Here is the list:

9.1. Node management
9.2. User management
9.3. Password management
9.4. Technique creation
9.5. REST API
9.6. Server optimization
9.7. Server migration
9.8. Rudder Server data workflow
9.9. Rudder Agent workflow
9.10. Configuration files for a Node
9.11. Configuration files for Rudder Server

Does it suit you ?

Actions

Copy link