From b04aa230b9f329b636061413a4306a8ecfc3cb97 Mon Sep 17 00:00:00 2001 From: Yih Leong Sun Date: Sat, 21 Jan 2017 00:00:13 +0000 Subject: [PATCH] fix typo in HACKING.rst and move workload-template.rst to root Change-Id: I936ed441644a159bea4437f6be83c728693ddef5 --- HACKING.rst | 10 +++++----- .../workload-template.rst => workload-template.rst | 9 +++++++-- 2 files changed, 12 insertions(+), 7 deletions(-) rename workload-ref-archs/workload-template.rst => workload-template.rst (92%) diff --git a/HACKING.rst b/HACKING.rst index 8f0b8a6..69a1731 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -35,23 +35,23 @@ Submission Process git checkout -b -#. Create the following directory structures under `workload-ref-archs `_ +#. Create the following directory structures under `doc/source `_ for the new workload:: /.rst - /figure + /figures /sample/heat /sample/murano .. list-table:: :widths: 15 25 - * - .rst + * - .rst - Provides a full description of the workload. - Please follow the structure in `workload-template.rst `_ + Please follow the structure in `workload-template.rst `_ - * - figure + * - figures - Include all images in this folder * - sample/heat diff --git a/workload-ref-archs/workload-template.rst b/workload-template.rst similarity index 92% rename from workload-ref-archs/workload-template.rst rename to workload-template.rst index 3a91ebf..af738ad 100644 --- a/workload-ref-archs/workload-template.rst +++ b/workload-template.rst @@ -14,7 +14,7 @@ OpenStack for 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. \ No newline at end of file