diff --git a/doc/source/discussion/index.rst b/doc/source/discussion/index.rst index 6bf3de7b5b..a02b5ff971 100644 --- a/doc/source/discussion/index.rst +++ b/doc/source/discussion/index.rst @@ -14,6 +14,5 @@ configure it to meet your needs. concepts components gating - tenants encryption tenant-scoped-rest-api diff --git a/doc/source/index.rst b/doc/source/index.rst index 5ca225a7b3..d31a3b3a50 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -34,6 +34,7 @@ Zuul Admins tutorials/admins/index howtos/admins/index + reference/admins/index Digging Deeper ************** diff --git a/doc/source/reference/client.rst b/doc/source/reference/admins/client.rst similarity index 100% rename from doc/source/reference/client.rst rename to doc/source/reference/admins/client.rst diff --git a/doc/source/reference/connections.rst b/doc/source/reference/admins/connections.rst similarity index 64% rename from doc/source/reference/connections.rst rename to doc/source/reference/admins/connections.rst index a551c853e7..62f6eed229 100644 --- a/doc/source/reference/connections.rst +++ b/doc/source/reference/admins/connections.rst @@ -18,9 +18,9 @@ Connections In order to interact with external systems, Zuul must have a *connection* to that system configured. Zuul includes a number of -drivers, each of which implements the functionality necessary to -connect to a system. Each connection in Zuul is associated with a -driver. +:ref:`drivers `, each of which implements the functionality +necessary to connect to a system. Each connection in Zuul is +associated with a driver. To configure a connection in Zuul, select a unique name for the connection and add a section to ``zuul.conf`` with the form @@ -41,33 +41,3 @@ for a given server, however, if you need more than one (for example, to satisfy unique reporting requirements) be sure to list the primary connection first as that is what Zuul will use to look up all changes for that server. - -.. _drivers: - -Drivers -------- - -Drivers may support any of the following functions: - -* Sources -- hosts git repositories for projects. Zuul can clone git - repos for projects and fetch refs. -* Triggers -- emits events to which Zuul may respond. Triggers are - configured in pipelines to cause changes or other refs to be - enqueued. -* Reporters -- outputs information when a pipeline is finished - processing an item. - -Zuul includes the following drivers: - -.. toctree:: - :maxdepth: 2 - - drivers/gerrit - drivers/github - drivers/pagure - drivers/git - drivers/mqtt - drivers/smtp - drivers/sql - drivers/timer - drivers/zuul diff --git a/doc/source/reference/drivers/gerrit.rst b/doc/source/reference/admins/drivers/gerrit.rst similarity index 100% rename from doc/source/reference/drivers/gerrit.rst rename to doc/source/reference/admins/drivers/gerrit.rst diff --git a/doc/source/reference/drivers/git.rst b/doc/source/reference/admins/drivers/git.rst similarity index 100% rename from doc/source/reference/drivers/git.rst rename to doc/source/reference/admins/drivers/git.rst diff --git a/doc/source/reference/drivers/github.rst b/doc/source/reference/admins/drivers/github.rst similarity index 100% rename from doc/source/reference/drivers/github.rst rename to doc/source/reference/admins/drivers/github.rst diff --git a/doc/source/reference/admins/drivers/index.rst b/doc/source/reference/admins/drivers/index.rst new file mode 100644 index 0000000000..4413f4f049 --- /dev/null +++ b/doc/source/reference/admins/drivers/index.rst @@ -0,0 +1,29 @@ +.. _drivers: + +Drivers +======= + +Drivers may support any of the following functions: + +* Sources -- hosts git repositories for projects. Zuul can clone git + repos for projects and fetch refs. +* Triggers -- emits events to which Zuul may respond. Triggers are + configured in pipelines to cause changes or other refs to be + enqueued. +* Reporters -- outputs information when a pipeline is finished + processing an item. + +Zuul includes the following drivers: + +.. toctree:: + :maxdepth: 2 + + gerrit + github + pagure + git + mqtt + smtp + sql + timer + zuul diff --git a/doc/source/reference/drivers/mqtt.rst b/doc/source/reference/admins/drivers/mqtt.rst similarity index 100% rename from doc/source/reference/drivers/mqtt.rst rename to doc/source/reference/admins/drivers/mqtt.rst diff --git a/doc/source/reference/drivers/pagure.rst b/doc/source/reference/admins/drivers/pagure.rst similarity index 100% rename from doc/source/reference/drivers/pagure.rst rename to doc/source/reference/admins/drivers/pagure.rst diff --git a/doc/source/reference/drivers/smtp.rst b/doc/source/reference/admins/drivers/smtp.rst similarity index 100% rename from doc/source/reference/drivers/smtp.rst rename to doc/source/reference/admins/drivers/smtp.rst diff --git a/doc/source/reference/drivers/sql.rst b/doc/source/reference/admins/drivers/sql.rst similarity index 100% rename from doc/source/reference/drivers/sql.rst rename to doc/source/reference/admins/drivers/sql.rst diff --git a/doc/source/reference/drivers/timer.rst b/doc/source/reference/admins/drivers/timer.rst similarity index 100% rename from doc/source/reference/drivers/timer.rst rename to doc/source/reference/admins/drivers/timer.rst diff --git a/doc/source/reference/drivers/zuul.rst b/doc/source/reference/admins/drivers/zuul.rst similarity index 100% rename from doc/source/reference/drivers/zuul.rst rename to doc/source/reference/admins/drivers/zuul.rst diff --git a/doc/source/reference/admins/index.rst b/doc/source/reference/admins/index.rst new file mode 100644 index 0000000000..19078b1355 --- /dev/null +++ b/doc/source/reference/admins/index.rst @@ -0,0 +1,10 @@ +Admin Reference +=============== + +.. toctree:: + :maxdepth: 3 + + tenants + connections + drivers/index + client diff --git a/doc/source/discussion/tenants.rst b/doc/source/reference/admins/tenants.rst similarity index 100% rename from doc/source/discussion/tenants.rst rename to doc/source/reference/admins/tenants.rst diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index 5f634fed93..f621b1dbb7 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -4,8 +4,6 @@ Reference .. toctree:: :maxdepth: 2 - connections - client monitoring web developer/index