I have finished a first draft of the proposed docs reorganization map [0].
The important concepts that I kept in mind for this were that the
structure of RTD only allows navigating (via the left side) to 1 and A
level pages. Additionally, I think that the User guide is an unnecessary
level, given that devs are also users. By removing this level, get get a
lot more flexibility in the layout and I suspect that it will also
reduce the tendency for doubled information between the guides.
Here is a simplified version:
1. Index
2. Setup
A. installation
B. upgrading
C. release notes
3. Architecture
4. Conventions
A. Searching
B. Exception Handling
C. Error Details
D. Syn and Async
E. Schedules tasks
F. Incorporate from General Reference
5. Configuration
A. Pulp Broker Settings
B. Making a backup
C. Authentication
D. Content Source
E Tuning and Scaling
6. Admin Client
7. Consumer Client
8. Pulp Nodes
9. Integration Guide
A. REST API Reference
B. Events
10. Contributor Guide
A. Contributor setup
B. Branching and Merging
C. Documentation
D. Policies
E. Building Instructions
11. Troubleshooting
12. Bugs
13. Glossary
[0] http://pulp.etherpad.corp.redhat.com/168
_______________________________________________
Pulp-list mailing list
[email protected]
https://www.redhat.com/mailman/listinfo/pulp-list
