From bd07ddfabcab2d71a99754591419c848efb28232 Mon Sep 17 00:00:00 2001 From: "James E. Blair" Date: Mon, 6 Dec 2021 09:13:39 -0800 Subject: [PATCH] Reorganize docs This is an attempt to reorganize docs based on what we've learned so far: * Audience is important -- help users find the job syntax reference without getting bogged down in how to run zookeeper. * Having distinct tutorials, howtos, and reference documentation is helpful. * Grouping by subject matter is important; users shouldn't have to open tabs with howto, reference, and tutorial to synthesize all the information on a subject. This reorg reduces the use of explicit reference/howto/tutorial/discussion divisions since in some cases they never got sufficiently fleshed out (eg, user tutorials), and in others the information was spread too thinly across them all (eg authentication). However, those distinctions are still useful, and the new organization reflects that somewhat. I have made only some changes to content (generally in introductory sections in order to make things make sense) and added a new "about Zuul" page. We should still go through the documentation and update it and tweak the organization further. This is mostly an attempt to get a new framework in place. The theme is switched from alabaster to RTD. That's because RTD has really good support for a TOC tree in the side bar with expansion. That makes a big difference when trying to navigate large documentation like this. The new framework is intended to have very good left-hand navigation for users. Change-Id: I5ef88536acf1a1e58a07827e06b07d06588ecaf1 --- doc/requirements.txt | 1 + doc/source/_static/logo.svg | 100 ++++- doc/source/about.rst | 60 +++ doc/source/admin.rst | 16 + ...scoped-rest-api.rst => authentication.rst} | 31 +- doc/source/{reference => }/client.rst | 2 +- doc/source/components.rst | 90 +++++ doc/source/{discussion => }/concepts.rst | 16 +- doc/source/conf.py | 11 +- .../{reference/job_def.rst => config/job.rst} | 0 .../nodeset_def.rst => config/nodeset.rst} | 0 .../pipeline_def.rst => config/pipeline.rst} | 2 +- .../pragma_def.rst => config/pragma.rst} | 0 .../project_def.rst => config/project.rst} | 0 .../queue_def.rst => config/queue.rst} | 0 .../secret_def.rst => config/secret.rst} | 0 .../semaphore.rst} | 0 .../components.rst => configuration.rst} | 357 +++++------------- .../{reference => }/developer/ansible.rst | 0 .../{reference => }/developer/datamodel.rst | 0 doc/source/{reference => }/developer/docs.rst | 0 .../{reference => }/developer/drivers.rst | 0 .../{reference => }/developer/index.rst | 0 .../{reference => }/developer/javascript.rst | 0 .../developer/releasenotes.rst | 0 .../developer/specs/circular-dependencies.rst | 0 .../developer/specs/community-matrix.rst | 0 .../specs/enhanced-regional-executors.rst | 0 .../{reference => }/developer/specs/index.rst | 0 .../developer/specs/kubernetes-operator.rst | 0 .../developer/specs/tenant-resource-quota.rst | 0 .../specs/tenant-scoped-admin-web-API.rst | 0 .../developer/specs/zuul-runner.rst | 0 .../{reference => }/developer/testing.rst | 0 .../{reference => }/developer/triggers.rst | 0 .../{reference => }/developer/zookeeper.rst | 0 doc/source/discussion/encryption.rst | 61 --- doc/source/discussion/github-checks-api.rst | 189 ---------- doc/source/discussion/index.rst | 19 - .../{reference => }/drivers/elasticsearch.rst | 0 doc/source/{reference => }/drivers/gerrit.rst | 0 doc/source/{reference => }/drivers/git.rst | 0 doc/source/{reference => }/drivers/github.rst | 188 +++++++++ doc/source/{reference => }/drivers/gitlab.rst | 0 doc/source/{reference => }/drivers/index.rst | 0 doc/source/{reference => }/drivers/mqtt.rst | 0 doc/source/{reference => }/drivers/pagure.rst | 0 doc/source/{reference => }/drivers/smtp.rst | 0 doc/source/{reference => }/drivers/sql.rst | 0 doc/source/{reference => }/drivers/timer.rst | 0 doc/source/{reference => }/drivers/zuul.rst | 0 doc/source/{discussion => }/gating.rst | 0 doc/source/{reference => }/glossary.rst | 0 doc/source/{reference => }/governance.rst | 0 doc/source/howtos/admin.rst | 11 - doc/source/howtos/{user.rst => index.rst} | 6 +- doc/source/howtos/openid-connect-examples.rst | 21 -- doc/source/howtos/zookeeper.rst | 2 + doc/source/howtos/zuul-from-scratch.rst | 2 +- doc/source/index.rst | 56 ++- doc/source/{howtos => }/installation.rst | 195 +++------- .../{reference/jobs.rst => job-content.rst} | 2 + doc/source/{reference => }/monitoring.rst | 0 doc/source/operation.rst | 155 ++++++++ .../config.rst => project-config.rst} | 84 ++++- doc/source/reference/admin.rst | 11 - doc/source/reference/connections.rst | 43 --- doc/source/reference/database.rst | 49 --- doc/source/reference/index.rst | 13 - doc/source/reference/user.rst | 8 - doc/source/{reference => }/releasenotes.rst | 0 .../{reference/web.rst => rest-api.rst} | 2 +- doc/source/{reference => }/tenants.rst | 9 +- doc/source/{howtos => }/troubleshooting.rst | 0 doc/source/tutorials/admin.rst | 8 - doc/source/tutorials/keycloak.rst | 2 +- doc/source/tutorials/quick-start.rst | 2 +- doc/source/tutorials/user.rst | 11 - .../{reference => }/vulnerabilities.rst | 0 79 files changed, 907 insertions(+), 928 deletions(-) create mode 100644 doc/source/about.rst create mode 100644 doc/source/admin.rst rename doc/source/{discussion/tenant-scoped-rest-api.rst => authentication.rst} (87%) rename doc/source/{reference => }/client.rst (99%) create mode 100644 doc/source/components.rst rename doc/source/{discussion => }/concepts.rst (89%) rename doc/source/{reference/job_def.rst => config/job.rst} (100%) rename doc/source/{reference/nodeset_def.rst => config/nodeset.rst} (100%) rename doc/source/{reference/pipeline_def.rst => config/pipeline.rst} (99%) rename doc/source/{reference/pragma_def.rst => config/pragma.rst} (100%) rename doc/source/{reference/project_def.rst => config/project.rst} (100%) rename doc/source/{reference/queue_def.rst => config/queue.rst} (100%) rename doc/source/{reference/secret_def.rst => config/secret.rst} (100%) rename doc/source/{reference/semaphore_def.rst => config/semaphore.rst} (100%) rename doc/source/{discussion/components.rst => configuration.rst} (81%) rename doc/source/{reference => }/developer/ansible.rst (100%) rename doc/source/{reference => }/developer/datamodel.rst (100%) rename doc/source/{reference => }/developer/docs.rst (100%) rename doc/source/{reference => }/developer/drivers.rst (100%) rename doc/source/{reference => }/developer/index.rst (100%) rename doc/source/{reference => }/developer/javascript.rst (100%) rename doc/source/{reference => }/developer/releasenotes.rst (100%) rename doc/source/{reference => }/developer/specs/circular-dependencies.rst (100%) rename doc/source/{reference => }/developer/specs/community-matrix.rst (100%) rename doc/source/{reference => }/developer/specs/enhanced-regional-executors.rst (100%) rename doc/source/{reference => }/developer/specs/index.rst (100%) rename doc/source/{reference => }/developer/specs/kubernetes-operator.rst (100%) rename doc/source/{reference => }/developer/specs/tenant-resource-quota.rst (100%) rename doc/source/{reference => }/developer/specs/tenant-scoped-admin-web-API.rst (100%) rename doc/source/{reference => }/developer/specs/zuul-runner.rst (100%) rename doc/source/{reference => }/developer/testing.rst (100%) rename doc/source/{reference => }/developer/triggers.rst (100%) rename doc/source/{reference => }/developer/zookeeper.rst (100%) delete mode 100644 doc/source/discussion/encryption.rst delete mode 100644 doc/source/discussion/github-checks-api.rst delete mode 100644 doc/source/discussion/index.rst rename doc/source/{reference => }/drivers/elasticsearch.rst (100%) rename doc/source/{reference => }/drivers/gerrit.rst (100%) rename doc/source/{reference => }/drivers/git.rst (100%) rename doc/source/{reference => }/drivers/github.rst (71%) rename doc/source/{reference => }/drivers/gitlab.rst (100%) rename doc/source/{reference => }/drivers/index.rst (100%) rename doc/source/{reference => }/drivers/mqtt.rst (100%) rename doc/source/{reference => }/drivers/pagure.rst (100%) rename doc/source/{reference => }/drivers/smtp.rst (100%) rename doc/source/{reference => }/drivers/sql.rst (100%) rename doc/source/{reference => }/drivers/timer.rst (100%) rename doc/source/{reference => }/drivers/zuul.rst (100%) rename doc/source/{discussion => }/gating.rst (100%) rename doc/source/{reference => }/glossary.rst (100%) rename doc/source/{reference => }/governance.rst (100%) delete mode 100644 doc/source/howtos/admin.rst rename doc/source/howtos/{user.rst => index.rst} (56%) delete mode 100644 doc/source/howtos/openid-connect-examples.rst rename doc/source/{howtos => }/installation.rst (71%) rename doc/source/{reference/jobs.rst => job-content.rst} (99%) rename doc/source/{reference => }/monitoring.rst (100%) create mode 100644 doc/source/operation.rst rename doc/source/{reference/config.rst => project-config.rst} (62%) delete mode 100644 doc/source/reference/admin.rst delete mode 100644 doc/source/reference/connections.rst delete mode 100644 doc/source/reference/database.rst delete mode 100644 doc/source/reference/index.rst delete mode 100644 doc/source/reference/user.rst rename doc/source/{reference => }/releasenotes.rst (100%) rename doc/source/{reference/web.rst => rest-api.rst} (75%) rename doc/source/{reference => }/tenants.rst (98%) rename doc/source/{howtos => }/troubleshooting.rst (100%) delete mode 100644 doc/source/tutorials/admin.rst delete mode 100644 doc/source/tutorials/user.rst rename doc/source/{reference => }/vulnerabilities.rst (100%) diff --git a/doc/requirements.txt b/doc/requirements.txt index 795e3af5e4..1d030dd6a6 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -7,6 +7,7 @@ sphinxcontrib-blockdiag>=1.1.0 sphinxcontrib-programoutput sphinx-autodoc-typehints sphinxcontrib-openapi>=0.4.0 +sphinx_rtd_theme reno>=2.8.0 # Apache-2.0 zuul-client zuul-sphinx diff --git a/doc/source/_static/logo.svg b/doc/source/_static/logo.svg index ded6d34146..0cc6b72a24 100644 --- a/doc/source/_static/logo.svg +++ b/doc/source/_static/logo.svg @@ -1,22 +1,86 @@ - - - -