diff options
| author | Jeremy Stanley <fungi@yuggoth.org> | 2018-01-08 21:35:58 +0000 |
|---|---|---|
| committer | Jeremy Stanley <fungi@yuggoth.org> | 2018-01-08 21:37:29 +0000 |
| commit | 21df596e582d8cf1543b4dcdcbeec226cb4ab501 (patch) | |
| tree | b36d70595defbba7c50dfdd4eb5b6bed4b6fbc62 | |
| parent | f7f5bf4b1965198f636a010da625c5ef8db86309 (diff) | |
| download | zuul-21df596e582d8cf1543b4dcdcbeec226cb4ab501.tar.gz | |
Link to zuul-base-jobs docs from User's Guide
In the User's Guide section dealing with Git Repositories, link to
the zuul-base-jobs documentation to solve half of the TODO comment
there.
Change-Id: Ic333278f1f00184f033ab01ab4568e53b2e40fea
| -rw-r--r-- | doc/source/user/jobs.rst | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/source/user/jobs.rst b/doc/source/user/jobs.rst index 4b6255b20..9ec464671 100644 --- a/doc/source/user/jobs.rst +++ b/doc/source/user/jobs.rst @@ -63,12 +63,15 @@ in this format. Note that these git repositories are located on the executor; in order to be useful to most kinds of jobs, they will need to be present on -the test nodes. The ``base`` job in the standard library contains a +the test nodes. The ``base`` job in the standard library (see +`zuul-base-jobs documentation`_ for details) contains a pre-playbook which copies the repositories to all of the job's nodes. It is recommended to always inherit from this base job to ensure that behavior. -.. TODO: link to base job documentation and/or document src (and logs?) directory +.. _zuul-base-jobs documentation: https://docs.openstack.org/infra/zuul-base-jobs/jobs.html#job-base + +.. TODO: document src (and logs?) directory Variables --------- |