Commit Graph

7 Commits

Author SHA1 Message Date
Duc Truong 5ae51e7344 Fix doc glossary terms
Glossary terms are case-sensitive. This change fixes the terms used in the
documentation to match the capitalization used in the glossary terms.

Change-Id: I6cc2cf7251e53c98c512f21c6504a2e795c26b33
2020-04-22 10:01:16 -07:00
Duc Truong 452d71c7cd Fix doc format errors
This fixes all the documentation formatting errors detected by sphinx
when running the docs tox environment.

The change in conf.py is needed to suppress the unknown option warning
documented in [1] and [2]

[1] https://groups.google.com/forum/#!topic/sphinx-users/6F_EJUEA2f8
[2] https://github.com/sphinx-doc/sphinx/issues/2229

Change-Id: Ib209fa9db7d2d896a34c54919afa396044ad29b7
2018-07-12 17:44:36 +00:00
tengqm 12dabd97ca Reorg the documentation structure
We have been using a documentation structure with useful information
nested very deep in the tree. This proposed change is about moving some
of them out of the tree to top-level for easier navigation.

Change-Id: I402136ec7e28ae44c1fedef990a5fd64da7bff2e
2016-12-21 06:33:31 -05:00
Liuqing Jing 06b51d545d Add senlin-dashboard in doc/source/overview.rst
Change-Id: Ide9fd1d24d7ac45ef85a411ac61b58b28576c907
2016-04-06 08:21:48 +00:00
tengqm a482de0f87 Rework senlin docs based on CLI changes
This patch reworks the senlin documentation to reflect recent changes to
the senlinclient where the senlin command line is completely dropped.

Change-Id: Ia30d67935281695cc94205942df1ca2b3df6feae
2016-03-28 04:54:46 -04:00
Thomas Goirand d38403e3a9 Fix spelling mistake
Typo in short description, reproduced in multiple files:
homogenous -> homogeneous

Change-Id: I062119b9bb9e7b536c575d42209e4e56e86239c0
2016-01-25 05:55:34 +00:00
tengqm cd37010080 Reorganize documentation
This patch reorgs the documentation structure. After this reorg, the top
level structure becomes:

  - overview
  - install
  - getting started
  - contributing to Senlin
  - glossary
  - man pages

Change-Id: I21ad4375e7c7baef46cbb2a51f7f38f40e275742
2015-12-02 05:15:28 -05:00