fix typo in HACKING.rst and move workload-template.rst to root

Change-Id: I936ed441644a159bea4437f6be83c728693ddef5
This commit is contained in:
Yih Leong Sun 2017-01-21 00:00:13 +00:00
parent 5b48e78bc8
commit b04aa230b9
2 changed files with 12 additions and 7 deletions

View File

@ -35,23 +35,23 @@ Submission Process
git checkout -b <workload-name>
#. Create the following directory structures under `workload-ref-archs <workload-ref-archs>`_
#. Create the following directory structures under `doc/source <doc/source>`_
for the new workload::
<workload-name>
<workload-name>/<workload-name>.rst
<workload-name>/figure
<workload-name>/figures
<workload-name>/sample/heat
<workload-name>/sample/murano
.. list-table::
:widths: 15 25
* - <workload-name>.rst
* - <workload-name>.rst
- Provides a full description of the workload.
Please follow the structure in `workload-template.rst <workload-ref-archs/workload-template.rst>`_
Please follow the structure in `workload-template.rst <workload-template.rst>`_
* - figure
* - figures
- Include all images in this folder
* - sample/heat

View File

@ -14,7 +14,7 @@ OpenStack for <workload>
This section provides detailed information on which OpenStack services
are required to support this workload.
Please include all **core** and **optional** services.
Please include all **core** and **optional** services.
Please provide a brief description of each services used in this document.
For example:
@ -56,10 +56,15 @@ sufficient information to explain what the sample code is trying to achieve.
Scope and Assumptions
---------------------
This section describe the specific scope, limitation or assumption made for
This section describes the specific scope, limitation or assumption made for
this workload reference architecture.
For example: The Heat template provided for this reference architecture
assumes that the web application workload is deployed in a single-region,
single-zone OpenStack environment. The deployment in a multi-zone/multi-region
environment is outside the scope of this document.
Summary
-------
This section concludes the document.