...
|
...
|
@@ -126,14 +126,9 @@ and can stay in the project file.
|
126
|
126
|
Documentation
|
127
|
127
|
-------------
|
128
|
128
|
|
129
|
|
-The official DevStack repo on GitHub does not include a gh-pages branch that
|
130
|
|
-GitHub uses to create static web sites. That branch is maintained in the
|
131
|
|
-`CloudBuilders DevStack repo`__ mirror that supports the
|
132
|
|
-http://devstack.org site. This is the primary DevStack
|
133
|
|
-documentation along with the DevStack scripts themselves.
|
134
|
|
-
|
135
|
|
-__ repo_
|
136
|
|
-.. _repo: https://github.com/cloudbuilders/devstack
|
|
129
|
+The DevStack repo now contains all of the static pages of devstack.org in
|
|
130
|
+the ``doc/source`` directory. The OpenStack CI system rebuilds the docs after every
|
|
131
|
+commit and updates devstack.org (now a redirect to docs.openstack.org/developer/devstack).
|
137
|
132
|
|
138
|
133
|
All of the scripts are processed with shocco_ to render them with the comments
|
139
|
134
|
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.
|
144
|
144
|
.. _shocco: https://github.com/dtroyer/shocco/tree/rst_support
|
145
|
145
|
|
146
|
146
|
The script used to drive <code>shocco</code> is <code>tools/build_docs.sh</code>.
|
|
147
|
+The complete docs build is also handled with <code>tox -edocs</code> per the
|
|
148
|
+OpenStack project standard.
|
147
|
149
|
|
148
|
150
|
|
149
|
151
|
Exercises
|
...
|
...
|
@@ -235,8 +232,12 @@ DevStack defines a bash set of best practices for maintaining large
|
235
|
235
|
collections of bash scripts. These should be considered as part of the
|
236
|
236
|
review process.
|
237
|
237
|
|
238
|
|
-We have a preliminary enforcing script for this called bash8 (only a
|
239
|
|
-small number of these rules are enforced).
|
|
238
|
+DevStack uses the bashate_ style checker
|
|
239
|
+to enforce basic guidelines, similar to pep8 and flake8 tools for Python. The
|
|
240
|
+list below is not complete for what bashate checks, nor is it all checked
|
|
241
|
+by bashate. So many lines of code, so little time.
|
|
242
|
+
|
|
243
|
+.. _bashate: https://pypi.python.org/pypi/bashate
|
240
|
244
|
|
241
|
245
|
Whitespace Rules
|
242
|
246
|
----------------
|