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
This change adds a sphinx extention to build sections of the policy and
profile documentation from source code.
- Add new extension
- Modify contributor documentation for policies to show spec fields
from source code
- Modify user documentation for policies and profiles to show properties
from source code
- Modify user documentation for policies and profiles to include
samples extracted from examples directory
- Update tox to run pep8 against sphinx extension
Change-Id: I32f68867d14c3288385dbdf3b4df14e8ca2fd01f
This patch fixes several problems in the doc tree:
- The scaling and heat integration subsections should be removed
from
tutorial, which is meant to be a quick introduction to senlin
operations.
- Moved some overview text from the global index into a dedicated
subsection for the autoscaling section.
- Fixed some problems related to format code blocks.
- Fixed the git command problem in the conf file.
Change-Id: Ice538cf65deb241d745f6793200bf09342ae227d
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
Since we have migrated API docs from api-site back in-tree, and the new
publisher job is putting docs into a different URL, we need to revise
the links so that they point to the correct location.
Change-Id: Ic11732fa51e1a1b661a9c742ca266b51ce957a05
This patch is about a framework for user tutorial documentation. This
documentation is about walking users from very basic commands to more
advanced usages. When contents are filled in, we can reference the more
detailed descriptions in the user reference documentation.
Change-Id: Ie623320af08dbe716bd21978e8468e36cef15f1f
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
This patch fixes the RST documents so that they align better to the
global guideline:
http://docs.openstack.org/contributor-guide/rst-conv/titles.html
This patch also fixes some trivial warnings emitted from docs test
cases.
Change-Id: Ibc9c3058c4018df570f464c9c955b3647b5995d5
The previous directory organization fails to generate a correct PDF
output. This patch proposes a different layout to fix it.
Change-Id: I55aa5c9d47bdf07287dbba6892799956708b9136
This is a first step for the getting started document. Will work on
other components in following patches.
Change-Id: I2020c758f845c951e7af116ff965692357f1f066
This is a initial version of the developer document. It describes the
targeted use cases and the design decisions made to meet the requirements.
This patch only contains docs related to cluster and node. Following
patch will provide doc on other objects and/or components.
Change-Id: I9b435ee0e890cb4e985ce739cf8948b7bbb93d95
We need to start working on some introductory materials for the project
and service. We may also need to document our thoughts and design
decisions when moving forward. This patch tries to provide a basic
layout of the documents.
Change-Id: Iad4affead02d605c6fce2720adc85141fd1dc419
This is an initial version of the design doc for authentication and
authorization in Senlin. There will be future improvements and
revisions.
Change-Id: I5f3d3dc1fb14237e357d1520ef1755626e2744ed
Duc Truong