workload-ref-archs/HACKING.rst

workload-ref-archs Style Commandments

• Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/
• Read the OpenStack Documentation Contributor Guide, especially the Writing style, RST conventions and Diagram guidelines

Proposing a new Workload Reference Architecture

• Anyone can propose new Workload Reference Architecture
• Anyone can propose to enhance or modify existing Workload Reference Architecture
• All proposal will be reviewed by the core team members of Enterprise WG

Submission Process

1. Follow the instructions at First timers to configure a local environment.

2. Clone the repository:

   git clone https://github.com/openstack/workload-ref-archs.git

3. Create a branch for the new workload :

   git checkout -b <workload-name>

4. Create the following directory structures under doc/source for the new workload:

   <workload-name>
   <workload-name>/<workload-name>.rst
   <workload-name>/figures
   <workload-name>/sample/heat
   <workload-name>/sample/murano

   <workload-name>.rst	Provides a full description of the workload. Please follow the structure in workload-template.rst
   figures	Include all images in this folder
   sample/heat	Include sample code for heat (if any)
   sample/murano	Include sample code for murano (if any)

5. Commit the changes:

   git commit -a -m "new workload <workload-name>"

6. Submit the changes for review, use the "new-workload" topic for new workload:

   git review -t new-workload

7. The core reviewers of the Workload Reference Architectures team will review the submision.