openstack/devstack
Code Issues Proposed changes

Update docs section for new build

Browse Source 
The devstack.org build process was recently changed to run as a CI post
job, publishing the site after every commit.

Change-Id: I05ddb353fae524178a25f28f2437d4fc635167f9
This commit is contained in:
Dean Troyer 2014-10-21 11:16:58 -05:00
parent 56d4919a1a
commit f5cb1ce4c6
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
HACKING.rst
View File

@ -126,14 +126,9 @@ and can stay in the project file.
Documentation
-------------
The official DevStack repo on GitHub does not include a gh-pages branch that
GitHub uses to create static web sites. That branch is maintained in the
`CloudBuilders DevStack repo`__ mirror that supports the
http://devstack.org site. This is the primary DevStack
documentation along with the DevStack scripts themselves.
__ repo_
.. _repo: https://github.com/cloudbuilders/devstack
The DevStack repo now contains all of the static pages of devstack.org in
the ``doc/source`` directory. The OpenStack CI system rebuilds the docs after every
commit and updates devstack.org (now a redirect to docs.openstack.org/developer/devstack).
All of the scripts are processed with shocco_ to render them with the comments
as text describing the script below. For this reason we tend to be a little
@ -144,6 +139,8 @@ uses Markdown headers to divide the script into logical sections.
.. _shocco: https://github.com/dtroyer/shocco/tree/rst_support
The script used to drive <code>shocco</code> is <code>tools/build_docs.sh</code>.
The complete docs build is also handled with <code>tox -edocs</code> per the
OpenStack project standard.
Exercises
@ -235,8 +232,12 @@ DevStack defines a bash set of best practices for maintaining large
collections of bash scripts. These should be considered as part of the
review process.
We have a preliminary enforcing script for this called bash8 (only a
small number of these rules are enforced).
DevStack uses the bashate_ style checker
to enforce basic guidelines, similar to pep8 and flake8 tools for Python. The
list below is not complete for what bashate checks, nor is it all checked
by bashate. So many lines of code, so little time.
.. _bashate: https://pypi.python.org/pypi/bashate
Whitespace Rules
----------------