Project

General

Profile

User story #8173

Change paragraph order in Documentation

Added by Vincent MEMBRÉ about 2 years ago. Updated 11 months ago.

Status:
Rejected
Priority:
N/A
Category:
Documentation
Target version:
Target version (plugin):
Suggestion strength:
User visibility:
Effort required:
Pull Request:

Description

While doing #8169, we had the idea to change of the documentation is organized.

First in #8169, We added a section before administration called: "Manage your IT", The goal of this section is to give adivce, best practices and explain how to things in your IT using Rudder.

We added one example how to here, but it more needs to be added. (in another issues!)

But by doing that we were not happy with the current organisation ...

We think "Rudder web interface", "Node Management", "Configuration management" and "Administration" sections should be put together into a section presenting Rudder and not be at the top level making a lighter modification

In fact i think "Rudder web interface", should be renamed to "Rudder" or "Rudder presentation" or "Rudder overview", with the three other section inside


Subtasks

User story #8251: Rewrite the manual introductionReleasedFrançois ARMAND
Bug #10668: Broken build after parent ticketReleasedFrançois ARMAND
User story #10670: Improve the manual introduction with content from other sourcesReleasedFrançois ARMAND
User story #8535: Move the "reference" section at the endReleasedJonathan CLARKE
User story #8536: Remove the usecases from the docRejectedAlexis MOUSSET
User story #8537: Move all administration/exploitation content to a dedicated sectionRejectedAlexis MOUSSET

Related issues

Related to Rudder - User story #10350: Change page split level and reorganize sectionsReleased
Has duplicate Rudder - User story #7707: Reorganize the documentation contentRejected2015-12-30

History

#1 Updated by François ARMAND about 2 years ago

That would be much appreciate. Today, "Configuration Management" at root level is very misleading. As an user, I'm surprised that that chapter don't talk at all about how to actually manage configuration in my system, with examples and hands on and the like.

#2 Updated by Alexis MOUSSET almost 2 years ago

#3 Updated by Alexis MOUSSET almost 2 years ago

I think we should reduce the number of top-level entries, and aim at something like:

  • Introduction
    • Features
    • Very high-level overview (data workflow, agent vs. server vs. relay, etc.)
  • Installation
    • Sizing
    • Requirements
    • Server Installation
    • Agent Installation
    • Relay Installation
  • Upgrade
    • Upgrade notes
    • How to
  • Usage
    • Concepts
    • Web Interface
    • Nodes
    • Configuration policies
  • Configuration management
    • Organize your policies
    • Secutiry considerations
    • Write you own techniques
  • Administration
    • Multiserver
    • Backup
    • Monitoring
    • Migration
  • Troubleshooting
    • Debugging methodology and tools
    • Common issues
  • Reference
    • low-level workflow
    • internal architecture
    • generic methods
    • packages
    • man pages

#4 Updated by Alexis MOUSSET almost 2 years ago

  • Status changed from New to In progress
  • Assignee set to Alexis MOUSSET

#5 Updated by Vincent MEMBRÉ almost 2 years ago

  • Target version changed from 2.11.21 to 2.11.22

#6 Updated by Vincent MEMBRÉ almost 2 years ago

  • Target version changed from 2.11.22 to 2.11.23

#7 Updated by Vincent MEMBRÉ over 1 year ago

  • Target version changed from 2.11.23 to 2.11.24

#8 Updated by Vincent MEMBRÉ over 1 year ago

  • Target version changed from 2.11.24 to 308

#9 Updated by Vincent MEMBRÉ over 1 year ago

  • Target version changed from 308 to 3.1.14

#10 Updated by Vincent MEMBRÉ over 1 year ago

  • Target version changed from 3.1.14 to 3.1.15

#11 Updated by Vincent MEMBRÉ over 1 year ago

  • Target version changed from 3.1.15 to 3.1.16

#12 Updated by Vincent MEMBRÉ over 1 year ago

  • Target version changed from 3.1.16 to 3.1.17

#13 Updated by Vincent MEMBRÉ over 1 year ago

  • Target version changed from 3.1.17 to 3.1.18

#14 Updated by Vincent MEMBRÉ about 1 year ago

  • Target version changed from 3.1.18 to 3.1.19

#15 Updated by Alexis MOUSSET about 1 year ago

  • Related to User story #10350: Change page split level and reorganize sections added

#16 Updated by Vincent MEMBRÉ about 1 year ago

  • Target version changed from 3.1.19 to 3.1.20

#17 Updated by Vincent MEMBRÉ 11 months ago

  • Target version changed from 3.1.20 to 3.1.21

#18 Updated by Alexis MOUSSET 11 months ago

  • Status changed from In progress to Rejected

This has been done in subtasks, closing.

Also available in: Atom PDF