User story #8173
closed
Change paragraph order in Documentation
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
Updated by François ARMAND almost 10 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.
Updated by Alexis Mousset almost 10 years ago
- Has duplicate User story #7707: Reorganize the documentation content added
Updated by Alexis Mousset almost 10 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
Updated by Alexis Mousset almost 10 years ago
- Status changed from New to In progress
- Assignee set to Alexis Mousset
Updated by Vincent MEMBRÉ over 9 years ago
- Target version changed from 2.11.21 to 2.11.22
Updated by Vincent MEMBRÉ over 9 years ago
- Target version changed from 2.11.22 to 2.11.23
Updated by Vincent MEMBRÉ over 9 years ago
- Target version changed from 2.11.23 to 2.11.24
Updated by Vincent MEMBRÉ over 9 years ago
- Target version changed from 2.11.24 to 308
Updated by Vincent MEMBRÉ over 9 years ago
- Target version changed from 308 to 3.1.14
Updated by Vincent MEMBRÉ over 9 years ago
- Target version changed from 3.1.14 to 3.1.15
Updated by Vincent MEMBRÉ over 9 years ago
- Target version changed from 3.1.15 to 3.1.16
Updated by Vincent MEMBRÉ over 9 years ago
- Target version changed from 3.1.16 to 3.1.17
Updated by Vincent MEMBRÉ about 9 years ago
- Target version changed from 3.1.17 to 3.1.18
Updated by Vincent MEMBRÉ about 9 years ago
- Target version changed from 3.1.18 to 3.1.19
Updated by Alexis Mousset almost 9 years ago
- Related to User story #10350: Change page split level and reorganize sections added
Updated by Vincent MEMBRÉ almost 9 years ago
- Target version changed from 3.1.19 to 3.1.20
Updated by Vincent MEMBRÉ almost 9 years ago
- Target version changed from 3.1.20 to 3.1.21
Updated by Alexis Mousset almost 9 years ago
- Status changed from In progress to Rejected
This has been done in subtasks, closing.