Project

General

Profile

Actions
Copy link

User story #6604

closed

Split the html documentation to improve readability and navigability

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

Status:
Released
Priority:
N/A
Assignee:
Jonathan CLARKE
Category:
Documentation
Target version:
2.10.17
Pull Request:
https://github.com/Normation/rudder-d...
UX impact:
Suggestion strength:
User visibility:
Effort required:
Name check:
Fix check:
Regression:

Description

The current html manual is a very long web page in which it may be difficult to find your way, especially because the left menu requires a lot of scrolling.

We could use the docbook webhelp output format, which would not require any modifications of the source files. It is for example used by OpenStack and neo4j.

Files

Download all files
Screenshot from 2015-08-17 10-59-34.png (167 KB) Screenshot from 2015-08-17 10-59-34.png screenshot Alexis Mousset, 2015-08-17 12:01
Screenshot from 2015-08-17 16-33-38.png (245 KB) Screenshot from 2015-08-17 16-33-38.png screenshot Alexis Mousset, 2015-08-17 16:34

Subtasks 5 (0 open — 5 closed)

User story #7112: Add indexation to enable searchReleasedJonathan CLARKE2015-08-18Actions
User story #7115: Fix favicon linkReleasedJonathan CLARKE2015-08-19Actions
User story #7117: Use the webhelp doc as embedded doc in the webappReleasedJonathan CLARKE2015-11-23Actions
Bug #7437: Embedded docs don't display the correct index.html fileReleasedBenoît PECCATTE2015-11-23Actions
User story #7120: Remove uneeded and un-existent file from webhelp cssReleasedJonathan CLARKE2015-08-19Actions
Actions
Copy link
 #1

Updated by Alexis Mousset almost 9 years ago

  • Category set to Documentation
Actions
Copy link
 #2

Updated by Alexis Mousset almost 9 years ago

  • Tracker changed from Question to User story
  • Target version changed from Ideas (not version specific) to 3.2.0~beta1
Actions
Copy link
 #3

Updated by Alexis Mousset almost 9 years ago

  • Status changed from New to In progress
  • Assignee set to Alexis Mousset
Actions
Copy link
 #4

Updated by Alexis Mousset almost 9 years ago

  • Pull Request set to https://github.com/Normation/rudder-doc/pull/122
Actions
Copy link
 #7

Updated by Alexis Mousset over 8 years ago

  • Target version changed from 3.2.0~beta1 to 2.10.17

Retargeting to 2.10.

Actions
Copy link
 #8

Updated by Alexis Mousset over 8 years ago

  • Status changed from In progress to Pending technical review
  • Assignee changed from Alexis Mousset to Jonathan CLARKE
  • Pull Request changed from https://github.com/Normation/rudder-doc/pull/122 to https://github.com/Normation/rudder-doc/pull/129
Actions
Copy link
 #9

Updated by Alexis Mousset over 8 years ago

  • Status changed from Pending technical review to Pending release
  • % Done changed from 0 to 100
Actions
Copy link
 #11

Updated by Vincent MEMBRÉ over 8 years ago

  • Status changed from Pending release to Released

This bug has been fixed in Rudder 2.10.17, 2.11.14, 3.0.9 and 3.1.2 which were released today.

Actions
Copy link

Also available in: Atom PDF