From 38fa5facdcfe317142a70cc88932bcc5f4396ca2 Mon Sep 17 00:00:00 2001 From: jkilpatr Date: Wed, 7 Jun 2017 09:18:55 -0400 Subject: [PATCH] Move ci docs to readthedocs Moving CI documentation to the modern location so that I can patch in documentation for these new workloads etc. Change-Id: I6d7fc4561d14d95f39df311cb2f76fd01fe215d1 --- ci-scripts/README.rst => doc/source/ci.rst | 30 ++++++++-------------- doc/source/index.rst | 1 + 2 files changed, 12 insertions(+), 19 deletions(-) rename ci-scripts/README.rst => doc/source/ci.rst (82%) diff --git a/ci-scripts/README.rst b/doc/source/ci.rst similarity index 82% rename from ci-scripts/README.rst rename to doc/source/ci.rst index a5259d94e..677564e11 100644 --- a/ci-scripts/README.rst +++ b/doc/source/ci.rst @@ -1,21 +1,13 @@ -Table of Contents -================= +===================== +Browbeat as a CI tool +===================== -- `CI Structure <#ci-structure>`__ -- `Script Documentation <#script-documentation>`__ - - - `Browbeat as a Quickstart Extra <#browbeat-as-a-quickstart-extra>`__ - - `Invoking Locally <#invoking-locally>`__ - -CI Structure -============ - -If you would like to make your own CI job add your CI script to this directory -and invoke it as minimally as possible on the Jenkins end, this will help us -keep script changes in the repository and better test them before merging. - -Script Documentation -==================== +If you would like to make your own CI job add your bootstrapping script to +`ci-scripts/` and Ansible/Python components into normal +locations in the repository. Try and provide as many defaults as possible so +that job definitions on the Jenkins end can remain small and easily defined. +this will help us keep script changes in the repository and better test them +before merging. Browbeat as a Quickstart Extra ------------------------------ @@ -101,5 +93,5 @@ enabled performance metrics will be gathered from all cloud nodes and stored into the configured graphite instance to be processed by the Grafana dashboards created using the given username and password. -These dashboards will be automatically overwritten each run to reflect the -number of nodes in your cloud and other changes that may occur between runs. +If enabled these dashboards will be automatically overwritten each run to reflect +the number of nodes in your cloud and other changes that may occur between runs. diff --git a/doc/source/index.rst b/doc/source/index.rst index 4065e6bf4..a9a4ffce7 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,6 +15,7 @@ Contents: installation usage plugins + ci contributing Indices and tables