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
This was missing and a user following this doc ran into exceptions
caused by git errors which happened because the git user was not
configured.
Change-Id: Iab50d58de8e798e63e8ed0459a903ebe60cecf5d
As of Zuul 3.7.0, the [zookeeper] section is required in zuul.conf
and is no longer implicitly defaulted (see release notes). Update
the Zuul From Scratch example config accordingly.
Change-Id: Ia9252efaed2eb20aba2a6f65d341d9b17cab9d64
This makes a number of changes to the installation/configuration
documentation in the admin manual.
Remove quick-start guide. The process of quick-starting is
covered by the installation and setup tutorial, which is now the
first of the installation sections. The reference material from
quick-start is now in the tutorial.
Rename the tutorial quick-start. It's nice to have something
named quick-start, and the tutorial fits the bill.
Rename the installation section "Installation Reference". This
now has more detailed information about installation and
deployment choices, but has very little procedural documentation.
Make zuul-from-scratch more internally consistent in style (use
code-block:: shell and heredocs wherever possible).
Change-Id: I7e4714ce5e775dc9ac0988c3470eef1f74fb36d6
This change adds instructions to Zuul From Scratch document
in order to prepare CentOS 7 system for Zuul and Nodepool
installation and configuration.
Steps to start/enable zookeeper service have been moved to distro
specific documents since the service name differs on distros.
Upcoming changes will add other sections such as installation
and configuration of Nodepool and Zuul.
Change-Id: Ie424a93d7e000d1e91801b45eb50173b58bc694e
Signed-off-by: Fatih Degirmenci <fdegir@gmail.com>
Also modify the Zuul From Scratch doc to reference these new files
in the service installation documents.
Depends-On: https://review.openstack.org/560993
Change-Id: Ifa0d1cd48ec5e1ef3358ada55b1b2769f392dfe9
In preparation for adding instructions for Gerrit and other
Linux derivatives, reorganize the "Zuul From Scratch" doc to
more easily incorporate those changes.
Also, just use the default Zookeeper config. That bit is
moved to be with the Zookeeper installation portion.
Change-Id: I206a2acf09eb8a2871ec61a00226654c798bb3eb
When setting up base jobs baseurl=https://git.zuul-ci.org/
There is no openstack-infra namespace so an error is thrown
when openstack-infra is in place
Change-Id: I9997e7c84bd32a3ee57615646146496a51627a86
Signed-off-by: Melvin Hillsman <mrhillsman@gmail.com>
A few small changes to make the instructions more robust
and clearer:
- list a few prerequisites, incl. accessibility of port
9000 by Github.
- Move the umask 066 command as close as possible to where it
belongs.
- clarify that webhook token==secret
- create the two Github repos before installing
the Github app into the Github org.
Change-Id: Id1ff18b454e9bd6b2ff8317ede652653b557e9e6
We now have a git mirror at git.zuul-ci.org with only the Zuul
git repos. Update references to git.openstack.org to use that.
Change-Id: I3e7b3b2e19468521548cc5179bbb2bf6d037ddf0
In the zuul-from-scratch doc the github webhook config assumes port 80
for webhooks. However the zuul-web default port is 9000 so change that
in the webhook config.
Change-Id: I84f1f2b71c0bcb60bf03cf5b486fe873ce8eaac2
This is just a skeleton for now, and should be expanded, but it
should be correct and up to date for what we expect in the v3
release.
Change-Id: I305200cbfc128cc1bc09e809540a873f60e0fe5c
Co-Authored-By: Leif Madsen <lmadsen@redhat.com>
Co-Authored-By: Monty Taylor <mordred@inaugust.com>
Co-Authored-By: Paul Belanger <pabelanger@redhat.com>
David Shrewsbury