Improve the documentation
The docs have been fairly neglected for a while. A lot of the information is outdated and/or disorganised. We should do a pass over the information, removing or updating old parts, as well as filling gaps where we find them. We should also update the docs to match the visual style of the docs team.
The documentation structure will be based off the spec at https:/
- install/ --This will cover installation, deployment and configuration of Horizon and its plugins. If a
consumer of Horizon is only interested in utilising it as part of their cloud, this section should provide
all the information they need.
- contributor/ -- Anything having to do with contributing to the project. This will include developer
setups, tutorial guides, and conceptual information. "Contributor" is important here, as it covers not
just direct code contributions, but also content about packaging, reviewing, etc.
- configuration/ -- Detailed information about configuring Horizon. This would include all of the settings
content.
Blueprint information
- Status:
- Complete
- Approver:
- Rob Cresswell
- Priority:
- High
- Drafter:
- Rob Cresswell
- Direction:
- Approved
- Assignee:
- None
- Definition:
- Approved
- Series goal:
- Accepted for 13.0.0-queens
- Implementation:
-
Implemented
- Milestone target:
-
queens-rc1
- Started by
- Rob Cresswell
- Completed by
- Akihiro Motoki
Related branches
Related bugs
Sprints
Whiteboard
[amotoki - Jan 29, 2018] the most efforts have been done in Pike and we can improve our docs if we have more topics as a separate bug or blueprint. Let's close it.
[amotoki - Jan 22, 2018] Can we close this blueprint? Is there anything remaining in this blueprint?
----
Gerrit topic: https:/
Addressed by: https:/
Update the quickstart guide
Addressed by: https:/
Update example local.conf
Addressed by: https:/
Update and merge the install / deployment docs
Addressed by: https:/
Fix the CLI symbol in the quickstart doc
Addressed by: https:/
doc: better formatting of TOC in sidebar
Addressed by: https:/
Reorganise and update the settings documentation
Addressed by: https:/
Update local conf
Addressed by: https:/
Minor improvements to the translation document
