From 566efcd81e6dc77cebc69d08333bcc45e18debd8 Mon Sep 17 00:00:00 2001 From: Marios Andreou Date: Tue, 29 Jan 2019 18:03:17 +0200 Subject: [PATCH] Move CI docs from contributor guide into new CI guide Creates a new CI guide in the index and moves all the ci docs from under the contributor index where they currently live. This makes it easier to find CI related docs and also makes the contributor guide index significantly shorter and so again easier to navigate for newcomer Change-Id: I8a2c6df43e23bed7572cc81929d0086335f6eb7a Related-Bug: #1804642 --- doc/source/{contributor => ci}/check_gates.rst | 0 doc/source/{contributor => ci}/ci_primer.rst | 4 ++-- .../{contributor => ci}/dlrn-promoter-overview.rst | 0 doc/source/ci/index.rst | 12 ++++++++++++ doc/source/{contributor => ci}/promotions.mmd | 0 doc/source/{contributor => ci}/reproduce-ci.rst | 0 doc/source/{contributor => ci}/stages-overview.rst | 0 doc/source/contributor/index.rst | 6 ------ doc/source/index.rst | 9 +++++++++ 9 files changed, 23 insertions(+), 8 deletions(-) rename doc/source/{contributor => ci}/check_gates.rst (100%) rename doc/source/{contributor => ci}/ci_primer.rst (98%) rename doc/source/{contributor => ci}/dlrn-promoter-overview.rst (100%) create mode 100644 doc/source/ci/index.rst rename doc/source/{contributor => ci}/promotions.mmd (100%) rename doc/source/{contributor => ci}/reproduce-ci.rst (100%) rename doc/source/{contributor => ci}/stages-overview.rst (100%) diff --git a/doc/source/contributor/check_gates.rst b/doc/source/ci/check_gates.rst similarity index 100% rename from doc/source/contributor/check_gates.rst rename to doc/source/ci/check_gates.rst diff --git a/doc/source/contributor/ci_primer.rst b/doc/source/ci/ci_primer.rst similarity index 98% rename from doc/source/contributor/ci_primer.rst rename to doc/source/ci/ci_primer.rst index 318e772a..9fa4c00e 100644 --- a/doc/source/contributor/ci_primer.rst +++ b/doc/source/ci/ci_primer.rst @@ -25,7 +25,7 @@ submission merges. This then means that the job is broken in subsequent check ru Non tripleo-projects are not gated in tripleo. The promotion jobs represent the point at which we take the latest built tripleo packages and the latest built non-tripleo projects packages (like nova, neutron etc) and test these together. -For more information about promotions refer to :doc:`Promotion Stages` +For more information about promotions refer to :doc:`Promotion Stages` Where do tripleo-ci jobs live ----------------------------- @@ -126,7 +126,7 @@ Where do tripleo promotion jobs live The tripleo promotions jobs are not defined in the tripleo-ci but instead live in the rdo-jobs_ repository. For more information about the promotion pipeline -in TripleO refer to the :doc:`Promotion Stages` +in TripleO refer to the :doc:`Promotion Stages` Similar to the tripleo-ci jobs, they are defined in various files under the rdo-jobs-zuul.d_ directory and the job definitions look very similar to the diff --git a/doc/source/contributor/dlrn-promoter-overview.rst b/doc/source/ci/dlrn-promoter-overview.rst similarity index 100% rename from doc/source/contributor/dlrn-promoter-overview.rst rename to doc/source/ci/dlrn-promoter-overview.rst diff --git a/doc/source/ci/index.rst b/doc/source/ci/index.rst new file mode 100644 index 00000000..ed3f753b --- /dev/null +++ b/doc/source/ci/index.rst @@ -0,0 +1,12 @@ +TripleO CI Guide +================ + +.. toctree:: + :maxdepth: 2 + :includehidden: + + ci_primer + reproduce-ci + check_gates + dlrn-promoter-overview + stages-overview diff --git a/doc/source/contributor/promotions.mmd b/doc/source/ci/promotions.mmd similarity index 100% rename from doc/source/contributor/promotions.mmd rename to doc/source/ci/promotions.mmd diff --git a/doc/source/contributor/reproduce-ci.rst b/doc/source/ci/reproduce-ci.rst similarity index 100% rename from doc/source/contributor/reproduce-ci.rst rename to doc/source/ci/reproduce-ci.rst diff --git a/doc/source/contributor/stages-overview.rst b/doc/source/ci/stages-overview.rst similarity index 100% rename from doc/source/contributor/stages-overview.rst rename to doc/source/ci/stages-overview.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 4efc2284..cc907cb3 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -7,10 +7,4 @@ TripleO Contributor Guide new_developers contributions - reproduce-ci - ci_primer - check_gates - dlrn-promoter-overview - stages-overview - .. include:: ./squads.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index dfef76de..6bf10169 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -16,6 +16,15 @@ Contributor Guide contributor/index developer/index +Tripleo CI Guide +---------------- + +.. toctree:: + :maxdepth: 3 + :includehidden: + + ci/index + Install Guide -------------