Optimize the documentation format
After we upgrading the sphinx ( 1.6.2) and openstackdocstheme (1.17.0), the current writing styles are no longer applicable. We need to update our docs to standard RST conventions.
Also, we need to follow the Contributor Guide[1] to keep the documentation format consistent:
- Code samples: https:/
- References: https:/
- Inline elements: https:/
- Writing style: https:/
Discussion about this bluesprint can be found here[2].
[1] https:/
[2] http://
Blueprint information
- Status:
- Complete
- Approver:
- Chason Chan
- Priority:
- Medium
- Drafter:
- Chason Chan
- Direction:
- Approved
- Assignee:
- Chason Chan
- Definition:
- Approved
- Series goal:
- Accepted for queens
- Implementation:
-
Implemented
- Milestone target:
-
queens-3
- Started by
- Chason Chan
- Completed by
- Jeffrey Zhang
Related branches
Related bugs
Sprints
Whiteboard
Gerrit topic: https:/
Addressed by: https:/
Upgrade the rst convention of the Contributor Guide
Addressed by: https:/
Upgrade the rst convention of the Admin Guide
Addressed by: https:/
Upgrade the rst convention of the User Guide
Addressed by: https:/
Upgrade the rst convention of the Reference Guide [1]
Addressed by: https:/
Upgrade the rst convention of the Reference Guide [2]
Addressed by: https:/
Upgrade the rst convention of the Reference Guide [3]
Addressed by: https:/
Upgrade the rst convention of the Reference Guide [4]
Work Items
Work items:
Admin Guide: INPROGRESS
Reference Guide: TODO
User Guide: INPROGRESS
Contributor Guide: INPROGRESS
