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
CentOS 7.x lacks python3, so just use the default python interpreter
when invoking pip to install git-review from PyPI. It also lacks
pip, and needs EPEL enabled to be able to install it.
Change-Id: I69b857eb2781e2a8a1df9bcaea4da9ad9396d17c
With the removal[*] of refs/publish in Gerrit 3.0.0, git-review
1.27.1 or later is needed to avoid attempting a push there and
ultimately failing. The git-review package in Ubuntu 18.04 LTS is
too old (1.26.0), so use latest from PyPI instead.
Adjust the quick-start document to install git-review with pip, and
on Debian/Ubuntu suggest including the python3-pip distro package
since it's split out separate from the interpreter packages.
[*] https://gerrit-review.googlesource.com/c/gerrit/+/192494
Change-Id: I247fb761667a99cf9f25478b49c5a1fe5d11a6cf
So that folks who would like to examine the config files without
running it (or, while running it) can do so easily in their browser.
Change-Id: I73396a4d63ffc2f1aea19569907d300757acd3ec
Using 'sudo -i' changes the working directory and so docker-compose
doesn't find the config file. Use 'sudo -E' instead to preserve the
environment variables in case http_proxy vars are needed.
Change-Id: Ib1da4a5c42029f3c0cf20b003fad09bc418b62ad
sudo -i is needed in case you have environment variables defined like
http_proxy, without it docker will not find them.
Change-Id: Ic3b728fe7f81278d266ec7945a1cfd709c6d3ca4
Tell users that the status page exists and point them to it during
the quick-start documentation.
Also, verify that it is served in the quick-start test job.
Change-Id: I8783ac731112af7752e8a7fc34e3337b52c382d9
* Tell folks to run 'sudo docker-compose up' in case their user
is not in the docker group.
* Turn off fact gathering in playbooks because we've seen some
leakage of device information from the host into the container
which causes ansible to query device info that doesn't exist.
We don't use facts anyway so this is faster too.
* Use register instead of rescue to figure out if users/projects
need to be created. It makes the ansible output tidier since
there won't be any (expected) failure tasks.
* Use the alpine image instead of centos for the gerritconfig
container. We're more likely to be able to re-use this layer
between this and the Zuul images than we would with centos
(because the gerrit container over-specifies the centos version).
* Capitalize the task names in playbooks. It looks better.
Change-Id: I428a2aea4e7544e04771d89e8d5627431cfaf1de
* Since we install docker-compose but docker is not installed,
It gives error to install and start docker service. The above
patch fixes the same and added step for installing and starting
docker services.
Change-Id: Ia2c8072693e5c4b9849ed4103b037bd642cd6ffe
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
Add a missing colon to the example pipeline configuration, and
use 'my_gerrit' for the connection name in the quick start to
make it more clear that it is modifiable.
Change-Id: I4f8de7c8e8df8e810f334e2440f4e6590ddd3883
Refresh the user and admin guide for v3 changes, and reorganize into
a narrative structure which makes more sense for v3.
Change-Id: I4ac3b18d5ed33b0fea4e2ef0318b19bfc3447ccc
David Shrewsbury