Commit Graph

11 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 f13cc924df Add option to report build page
This adds a tenant option to use the Zuul web build page as the
URL reported to the code review system when a build completes.

The setting is per-tenant (because it requires that the tenant
have a working SQL reporter configured in all pipelines) and
defaults to false, since we can't guarantee that.  In the future,
we expect to make SQL reporting implicit, then this can default
to true and eventually be deprecated.

A new zuul.conf option is added and marked required to supply
the root web URL.  As we perform further integration with the web
app, we may be able to deprecate other similar settings, such
as "status_url".

Change-Id: Iaa3be10525994722d020d2aa5a7dcf141f2404d9
2019-08-08 09:46:53 -07:00
Monty Taylor 86d1a29b9b Update SQLAlchemy url in docs
The existing url does not work.

Change-Id: Ie5bef54be0e4122a10d0042c2ee2f5328f68d043
2019-02-06 12:46:57 +00:00
gaobin 6aee478f5a Fixed the necesssary to necessary
Change-Id: Ic96a00618e1c98ee1b0339d360351be719aa676d
2018-12-08 20:39:26 +08:00
Tobias Henkel 94a1d08552 Support table prefix for sql reporter
In some environments zuul operators may have to rely on external
database providers. In this case it can be cumbersome to get extra
databases for each test environment. Adding an optional prefix to the
table names makes it possible to gracefully run several zuul
deployments against the same database and ensure they're still
isolated against each other.

Change-Id: Ib9948d6d74f4dc2453738f5d441e233e39e7f944
2017-12-09 12:30:24 +01:00
Joshua Hesketh 9322b0eb3a Allow the pool_recycle to be configured
Complete an outstanding todo.

Change-Id: I0ff7165d3f979c883733e1f438bb4b24569d290f
2017-10-16 15:55:12 +11:00
Joshua Hesketh 7ab7c63087 Clarify how the sql database is managed
Document that the sql driver handles alembic migrations for you and
remove the unused alembic.ini

Change-Id: I230b3ffe389a149bb63014b9f66962dd374cbac5
2017-10-16 15:32:09 +11:00
James E. Blair d5e2956411 Use null values instead of the empty dict for sql reporter
Change-Id: I23793e99e6ab6afdbe2f76a4433719a7f234ef5d
2017-08-04 10:31:03 -07:00
James E. Blair 83786d4418 Docs: reformat sql driver docs
Change-Id: I5279f3011b1358f8cb5a9b5fe6818fe4febd22a8
2017-08-04 10:31:03 -07:00
Monty Taylor 40f7f4dd84
Update SQL reporter to store results
Instead of a configuration of "score" - just store the build_set.result
field.

Change-Id: Iadac7d2660ba068c08e0888d2421deb435e9e833
2017-08-04 11:09:19 -05:00
James E. Blair eff5a9d8d7 Reorganize docs into user/admin guide
Refresh the user and admin guide for v3 changes, and reorganize into
a narrative structure which makes more sense for v3.

Change-Id: I4ac3b18d5ed33b0fea4e2ef0318b19bfc3447ccc
2017-07-05 14:35:22 -07:00