Commit Graph

5 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
Jan Kundrát 52b360cc12 Incoming connections over 19885/TCP are needed on nodes
This is already mentioned in Nodepool's operator guide when speaking
about clouds. Let's make sure that the same thing is mentioned when
speaking about a statically preconfigured set of nodes.

Change-Id: Icc7786d54a0a4c1f499704bcb0fb59199a30f615
2019-01-25 18:10:47 +01:00
James E. Blair a1d8fc7a51 Reorganize admin manual
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
2018-10-10 09:54:03 -07:00
James E. Blair ebb4c4a6be Add more explanatory text to zuul-from-scratch
Change-Id: I489fcb06d36998ba4287ce45fef1064fe6f2a3c3
2018-05-18 11:04:35 -07:00
David Shrewsbury b82e3c34bf Add static driver doc to Zuul From Scratch
Change-Id: Iac507cc0c37ed810cd03cd24314d1a7cf153bf91
2018-04-13 11:29:51 -04:00