From: Andrew Grimberg Date: Mon, 7 Mar 2022 21:43:22 +0000 (-0800) Subject: Docs: Update JJB documentation pointers X-Git-Tag: v0.75.0~1 X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F18%2F69818%2F1;p=releng%2Fglobal-jjb.git Docs: Update JJB documentation pointers JJB changed where they are hosting documentation and it's causing issues with Sphinx link checking Change-Id: Iedd85caa71cd45a706a278a020b7dab6b4612438 Signed-off-by: Andrew Grimberg --- diff --git a/docs/best-practices.rst b/docs/best-practices.rst index 632bca31..199422a6 100644 --- a/docs/best-practices.rst +++ b/docs/best-practices.rst @@ -181,7 +181,7 @@ Preserving Objects in Variable References JJB has an option to preserve a data structure object when you want to pass it to a template. -https://docs.openstack.org/infra/jenkins-job-builder/definition.html#variable-references +https://jenkins-job-builder.readthedocs.io/en/latest/definition.html#variable-references One thing that is not explicitly covered is the format of the variable name that you pass the object to. When you use the `{obj:key}` notation to preserve diff --git a/docs/conf.py b/docs/conf.py index ca63745c..c8325f7c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -276,7 +276,7 @@ htmlhelp_basename = 'LinuxFoundationReleaseEngineeringGJJBdoc' # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { - 'jjb': ('https://docs.openstack.org/infra/jenkins-job-builder/', None), + 'jjb': ('https://jenkins-job-builder.readthedocs.io/en/latest/', None), 'lfdocs': ('http://docs.releng.linuxfoundation.org/en/latest/', None), 'lftools': ('http://lftools.releng.linuxfoundation.org/en/latest/', None), 'python': ('https://docs.python.org/', None), diff --git a/docs/configuration.rst b/docs/configuration.rst index f2387914..239ee6af 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -182,7 +182,7 @@ jjbini ------ This file contains the Jenkins Job Builder `configuration -`_ +`_ for :doc:`jjb/lf-ci-jobs`. :Required: This file MUST exist. diff --git a/docs/jjb/lf-ci-jobs.rst b/docs/jjb/lf-ci-jobs.rst index 315bfc36..b8917244 100644 --- a/docs/jjb/lf-ci-jobs.rst +++ b/docs/jjb/lf-ci-jobs.rst @@ -947,7 +947,7 @@ recursively, we recommend to run from the base directory. :gerrit_trigger_file_paths: Override file paths which used to filter which file modifications will trigger a build. Refer to JJB documentation for "file-path" details. - https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + https://jenkins-job-builder.readthedocs.io/en/latest/triggers.html#triggers.gerrit :git-url: URL clone project from. (default: $GIT_URL/$GERRIT_PROJECT) :puppet-dir: Directory containing the project's puppet module(s) relative to the workspace. diff --git a/docs/jjb/lf-python-jobs.rst b/docs/jjb/lf-python-jobs.rst index be02609d..fde103df 100644 --- a/docs/jjb/lf-python-jobs.rst +++ b/docs/jjb/lf-python-jobs.rst @@ -237,7 +237,7 @@ https://docs.sonarqube.org/display/PLUG/Python+Coverage+Results+Import :gerrit_sonar_triggers: Override Gerrit Triggers. :gerrit_trigger_file_paths: Override file paths used to filter which file modifications trigger a build. Refer to JJB documentation for "file-path" details. - https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + https://jenkins-job-builder.readthedocs.io/en/latest/triggers.html#triggers.gerrit .. comment Stop ignoring @@ -435,7 +435,7 @@ variables before running. in tox.ini. (default: '') :gerrit_trigger_file_paths: Override file paths used to filter which file modifications trigger a build. Refer to JJB documentation for "file-path" details. - https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + https://jenkins-job-builder.readthedocs.io/en/latest/triggers.html#triggers.gerrit Tox Merge @@ -494,7 +494,7 @@ variables before running. in tox.ini. (default: '') :gerrit_trigger_file_paths: Override file paths used to filter which file modifications trigger a build. Refer to JJB documentation for "file-path" details. - https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + https://jenkins-job-builder.readthedocs.io/en/latest/triggers.html#triggers.gerrit PyPI Merge @@ -610,7 +610,7 @@ is optional, it defaults to pypi.org. in tox.ini. (default: '') :gerrit_trigger_file_paths: Override file paths used to filter which file modifications trigger a build. Refer to JJB documentation for "file-path" details. - https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + https://jenkins-job-builder.readthedocs.io/en/latest/triggers.html#triggers.gerrit PyPI Stage @@ -726,7 +726,7 @@ is optional, it defaults to pypi.org. in tox.ini. (default: '') :gerrit_trigger_file_paths: Override file paths used to filter which file modifications trigger a build. Refer to JJB documentation for "file-path" details. - https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + https://jenkins-job-builder.readthedocs.io/en/latest/triggers.html#triggers.gerrit PyPI Verify ----------- @@ -844,4 +844,4 @@ pyenv variables before running. in tox.ini. (default: '') :gerrit_trigger_file_paths: Override file paths used to filter which file modifications trigger a build. Refer to JJB documentation for "file-path" details. - https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + https://jenkins-job-builder.readthedocs.io/en/latest/triggers.html#triggers.gerrit diff --git a/docs/jjb/lf-whitesource-jobs.rst b/docs/jjb/lf-whitesource-jobs.rst index 0280edd1..092d140f 100644 --- a/docs/jjb/lf-whitesource-jobs.rst +++ b/docs/jjb/lf-whitesource-jobs.rst @@ -67,5 +67,5 @@ https://s3.amazonaws.com/unified-agent/wss-unified-agent.config :gerrit_trigger_file_paths: Override file paths which used to filter which file modifications will trigger a build. Refer to JJB documentation for "file-path" details. - https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + https://jenkins-job-builder.readthedocs.io/en/latest/triggers.html#triggers.gerrit :gerrit_wss_triggers: Override Gerrit Triggers. diff --git a/relnotes/v0.19.0.txt b/relnotes/v0.19.0.txt index 81aa0f50..2b8a4af4 100644 --- a/relnotes/v0.19.0.txt +++ b/relnotes/v0.19.0.txt @@ -35,7 +35,7 @@ The tox-verify job now has a parameter "gerrit_trigger_file_paths" that can be used to configure specific file path patterns that will trigger the job. Refer to the Gerrit Trigger JJB "file-path" documentation for config details. -https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit +https://jenkins-job-builder.readthedocs.io/en/latest/triggers.html#triggers.gerrit cc998bc Jeremy Phelps Add support to log into docker.io