Improve the documentation

Registered by Rob Cresswell

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

- 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

Blueprint information

Rob Cresswell
Rob Cresswell
Rob Cresswell
Series goal:
Accepted for 13.0.0-queens
Milestone target:
milestone icon queens-rc1
Started by
Rob Cresswell
Completed by
Akihiro Motoki

Related branches



[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:,topic:bp/pike-docs-overhaul,n,z

Addressed by:
    Update the quickstart guide

Addressed by:
    Update example local.conf

Addressed by:
    Update and merge the install / deployment docs

Addressed by:
    Fix the CLI symbol in the quickstart doc

Addressed by:
    doc: better formatting of TOC in sidebar

Addressed by:
    Reorganise and update the settings documentation

Addressed by:
    Update local conf

Addressed by:
    Minor improvements to the translation document


Work Items

This blueprint contains Public information 
Everyone can see this information.