Commit Graph

7 Commits

Author SHA1 Message Date
David Shrewsbury e6d8b210cc Documentation reorg
Reorganizing docs as recommended in:

https://www.divio.com/blog/documentation/

This is simply a reorganization of the existing documents and changes
no content EXCEPT to correct the location of sphinx doc references.
Expect followup changes to change document names (to reflect the new
structure) and to move content from existing guides (e.g., to move the
pipeline/project/job structure definitions out of the "Project Configuration"
reference guide into their own reference documents for easier locatability).

All documents are now located in either the "overview", "tutorials",
"discussions", or "references" subdirectories to reflect the new structure
presented to the user. Code examples and images are moved to "examples" and
"images" root-level directories.

Developer specific documents are located in the "references/developer"
directory.

Change-Id: I538ffd7409941c53bf42fe64b7acbc146023c1e3
2020-01-14 12:47:23 -05:00
James E. Blair d574702f24 Move reference pipelines out of the quickstart
The current location of the reference pipelines is within the
quick-start repo, which causes all sorts of configuration errors
to be logged (but since Zuul is so tolerant of them, the job
doesn't actually fail).

Move them outside of one of the demo project directories into their
own.

Change-Id: I9cb1ddd803d938fc154a32308cae99dbab9392e2
2019-09-17 15:35:18 -07:00
Fabien Boucher 60ece31607 Add reference pipelines file for Gerrit driver
As it has been done for the Pagure driver, include
a reference pipelines section in the Gerrit driver
documentation. It helps the reader to better
understand the big picture of the Gerrit's pipelines
configuration but also provide an almost ready to use
pipelines definition file.

Change-Id: I5234476f7393ba938e8365b8c908a2ff6f9e8c76
2019-08-27 14:47:07 +02:00
Fabien Boucher 3f98bb56be Fix reference pipelines syntax coloration for Pagure driver
Also move the reference pipelines in a separate yaml file that
can be simply reused.

Change-Id: If315b4cb1426a0379d31190f878ad163f7cfeeb1
2019-07-25 11:53:19 +02:00
Monty Taylor b0252eef9d Update references for opendev
Change-Id: I3c1ac5478efed4dee1d525deb036d457287fa136
2019-04-24 12:59:17 +00:00
James E. Blair 8bca70aadc Add mysql to quick-start
This allows us to show build history in the web ui.

Also add a local test playbook for the quickstart which basically
does what the zuul-quick-start job does, but expects to run locally
on a workstation (ie, does not install the docker registry and
docker).

Change-Id: Id62dcf69f48399dab3d1259679bf2fc2ce50460e
2018-10-16 11:13:41 -07:00
James E. Blair 8571b52ba8 Add docker-compose quickstart example
Use docker-compose to get a zuul+nodepool+gerrit up and configured
so that we can write walkthrough documentation which starts with
a running system.

Change-Id: I5819aee1fb9c3af72eb31818da476df074424225
Co-Authored-By: Tobias Henkel <tobias.henkel@bmw.de>
2018-10-09 14:36:06 -07:00