Files
zuul/doc/source/index.rst
James E. Blair bd07ddfabc 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
2021-12-15 15:25:31 -08:00

1.2 KiB

Zuul - A Project Gating System

Zuul is a program that drives continuous integration, delivery, and deployment systems with a focus on project gating and interrelated projects.

If you are looking for the Edge routing service named Zuul that is related to Netflix, it can be found here: https://github.com/Netflix/zuul

If you are looking for the Javascript testing tool named Zuul, it can be found here: https://github.com/defunctzombie/zuul

How To Use This Manual

If you have access to a Zuul system operated by someone else, then you may be interested in about-zuul and the following reference sections: project-configuration and job-content.

If you would like to learn how to run Zuul, try the quick-start.

If you are or will be responsible for installing and operating a Zuul System, the remainder of the sections will be useful.

about tutorials/quick-start project-config job-content admin rest-api howtos/index developer/index governance vulnerabilities releasenotes glossary

Indices and tables

  • genindex
  • search