From 005ff1d00e8840da6605ea44a71749f676333a7a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Magimel?= Date: Tue, 4 Dec 2018 21:01:44 +0100 Subject: [PATCH] Fix some URL redirections and broken links Use the new format of PyPI links. Use the Zuul domain name for Zuul doc links. Fix broken links (Oslo docs, Storyboard) or broken bookmarks. Change-Id: I4bfb63bf99c8528494d73f5f50018a2636b5bc37 --- doc/source/creators.rst | 23 +++++++++++------------ doc/source/developers.rst | 4 ++-- doc/source/drivers.rst | 9 ++++----- doc/source/zuulv3.rst | 28 ++++++++++++++-------------- 4 files changed, 31 insertions(+), 33 deletions(-) diff --git a/doc/source/creators.rst b/doc/source/creators.rst index 04e4c99..9fb7392 100644 --- a/doc/source/creators.rst +++ b/doc/source/creators.rst @@ -38,7 +38,7 @@ the OpenStack infrastructure, especially the docs.openstack.org and specs.openstack.org server. .. _governance site: https://governance.openstack.org -.. _OpenStack Project Teams: https://governance.openstack.org/reference/projects/index.html +.. _OpenStack Project Teams: https://governance.openstack.org/tc/reference/projects/index.html .. _Project Team Guide: https://docs.openstack.org/project-team-guide/ .. _related project: https://docs.openstack.org/infra/system-config/unofficial_project_hosting.html @@ -76,7 +76,7 @@ PyPI ---- Python packages need to have a unique name on the Python Package -Index (https://pypi.python.org) so we can publish source +Index (https://pypi.org) so we can publish source distributions to be installed via pip. It is best to name the repository and the top level Python package @@ -107,7 +107,7 @@ https://pypi.org/account/register/ as they are required for the next step. Once you have PyPI credentials see -https://packaging.python.org/tutorials/distributing-packages/ +https://packaging.python.org/tutorials/packaging-projects/ to create and upload your initial package. The initial package should contain a ``PKG-INFO`` file for a nonexistent version ``0`` of your package (that way any release you make is guaranteed to be higher). @@ -224,7 +224,7 @@ Viewing & Using Your Project's Task Tracker After the project-config change above has merged, all repositories will be created in Storyboard and you will be able to interact with them- filing bugs and adding requests -for new features in the `webclient `_. All +for new features in the `webclient `_. All repositories will be added to the group that was associated with the repositories in the project-config change. @@ -659,7 +659,7 @@ library edit the "Oslo" section: You can check which tags to use, or the meaning of any tag, by consulting the `list of currently allowed tags`_. -.. _list of currently allowed tags: https://governance.openstack.org/reference/tags/index.html +.. _list of currently allowed tags: https://governance.openstack.org/tc/reference/tags/index.html When writing the commit message for this change, make this change depend on the project creation change by including a link to its @@ -764,7 +764,7 @@ Start by checking out a copy of your new repository: $ git clone https://git.openstack.org/openstack/ -.. _cookiecutter: https://pypi.python.org/pypi/cookiecutter +.. _cookiecutter: https://pypi.org/project/cookiecutter .. code-block:: console @@ -853,8 +853,7 @@ template, as it'll be telling Zuul to run jobs that don't do anything, which is not needed once you have real jobs. For more information on writing jobs for Zuul, see -https://docs.openstack.org/infra/zuul/user/config.html -and :ref:`zuul_best_practices`. +https://zuul-ci.org/docs/zuul/user/config.html and :ref:`zuul_best_practices`. Verify That Gerrit and the Test Jobs are Working ================================================ @@ -970,7 +969,7 @@ If you need to check the logs, you can use the `git-os-job`_ command: $ git os-job $version -.. _git-os-job: https://pypi.python.org/pypi/git-os-job +.. _git-os-job: https://pypi.org/project/git-os-job See :ref:`tagging-a-release` in the Project Driver's Guide for more detail on tag pushing workflows. @@ -1054,8 +1053,8 @@ translations. For this, you first need to mark all strings so that they can be localized, use `oslo.i18n`_ for this and follow the `guidelines`_. -.. _oslo.i18n: https://docs.openstack.org/developer/oslo.i18n -.. _guidelines: https://docs.openstack.org/developer/oslo.i18n/guidelines.html +.. _oslo.i18n: https://docs.openstack.org/oslo.i18n/ +.. _guidelines: https://docs.openstack.org/oslo.i18n/latest/user/guidelines.html Note that this is just enabling translations, the actual translations are done by the i18n team, and they have to prioritize which projects @@ -1459,7 +1458,7 @@ the following: #. Will this be an official project? Then it needs a governance review, with a link to it via "Needed-By", and get PTL+1. -#. Will the repo release on pypi? Check that it https://pypi.python.org +#. Will the repo release on pypi? Check that it https://pypi.org is set up correctly. .. _Project Testing Interface: https://governance.openstack.org/tc/reference/project-testing-interface.html diff --git a/doc/source/developers.rst b/doc/source/developers.rst index f67816d..5e93d26 100644 --- a/doc/source/developers.rst +++ b/doc/source/developers.rst @@ -381,7 +381,7 @@ Make sure you have the latest upstream changes:: git pull --ff-only origin master Create a `topic branch -`_ +`_ to hold your work and switch to it. If you are working on a blueprint, name your topic branch ``bp/BLUEPRINT`` where BLUEPRINT is the name of a blueprint in Launchpad (for example, @@ -1106,6 +1106,6 @@ other repositories can be identified. Additional information about project gating and Zuul can be found in the Zuul documentation, located at: -https://docs.openstack.org/infra/zuul/user/gating.html +https://zuul-ci.org/docs/zuul/user/gating.html .. _`Running Python Unit Tests`: https://docs.openstack.org/project-team-guide/project-setup/python.html#running-python-unit-tests diff --git a/doc/source/drivers.rst b/doc/source/drivers.rst index 6a6fea2..3c8decb 100644 --- a/doc/source/drivers.rst +++ b/doc/source/drivers.rst @@ -491,11 +491,10 @@ If you want to add additional packages, you have several options. If you run Python tests using ``tox``, you can install them using ``requirements.txt`` and ``test-requirements.txt`` files (see also the -`global requirements process -`_). If these -Python tests need additional distribution packages installed as well -and if those are not in the nodes used for testing, they have to be -installed explicitly. +`global requirements process `_). +If these Python tests need additional distribution packages installed as well +and if those are not in the nodes used for testing, they have to be installed +explicitly. If you are building documentation, the file ``doc/requirements.txt`` is used instead to install Python packages. diff --git a/doc/source/zuulv3.rst b/doc/source/zuulv3.rst index 20a78cf..9f7247b 100644 --- a/doc/source/zuulv3.rst +++ b/doc/source/zuulv3.rst @@ -12,8 +12,8 @@ What is Zuul v3? .. sidebar:: Quick Links - * `Zuul v3 manual `__ - * `zuul-jobs `__ + * `Zuul v3 manual `__ + * `zuul-jobs `__ * `openstack-zuul-jobs `__ Zuul v3 is the third major version of the project gating system @@ -120,7 +120,7 @@ running them; jobs only need to be added to one system. All aspects of Zuul relating to jobs are configured with YAML files similar to the Zuul v2 layout. See the `Zuul User Guide -`_ +`_ for more information on how jobs are configured. Where Jobs Are Defined in Zuul v3 @@ -149,9 +149,9 @@ change its configuration in response to proposed changes. This is very powerful, but there are some limitations. See the sections of the Zuul User Guide about `Security Contexts -`_ +`_ and `Configuration Loading -`_ +`_ for more details. Note that all OpenStack projects share a single namespace for job @@ -180,7 +180,7 @@ allow us to express when a job should run in a human-friendly manner. Jobs, variants, and matchers are discussed in more detail in the `Job section of the Zuul manual - `_ + `_ Job definitions may appear more than once in the Zuul configuration. We call these multiple definitions *variants*. Job definitions have @@ -265,7 +265,7 @@ variant can't be used to "undo" an earlier matching variant. One final note about variants: in some cases Zuul attaches an implied branch matcher to job definitions. The rules are `tricky -`_, +`_, but in general, jobs defined in a multi-branch project get an implied branch matcher of their current branch. This makes it so that we can branch a project from master along with all of its job definitions, @@ -296,7 +296,7 @@ inheritance in Zuul allows us to build on an existing job. Base jobs and inheritance are discussed in more detail in the `Job section of the Zuul manual - `_ + `_ Every job in Zuul has a parent, except for jobs which we call *base jobs*. A base job is intended to handle fundamental tasks like @@ -447,7 +447,7 @@ change being tested were available as environment variables, generally prefixed with ``ZUUL_``. In Zuul v3, these have been replaced with Ansible variables which provide much more information as well as much richer structured data. See the `Job Content -`_ +`_ section of the Zuul User Guide for a full list. Secret Variables @@ -456,7 +456,7 @@ Secret Variables .. sidebar:: Further reading See the `Encryption section - `_ + `_ of the Zuul User Guide for more information on encryption and secrets A new feature in Zuul v3 is the ability to provide secrets which can be @@ -548,7 +548,7 @@ There is a base ``tox`` job and a set of jobs like ``tox-py27`` and The ``tox`` base job is what it sounds like - it's a base job. It knows how to run tox and fetch logs and results. It has parameters you can set to control its behavior, see the `description in zuul-jobs -`__ for details. +`__ for details. ``tox-py27`` is a job that uses the ``tox`` base job and sets ``tox_envlist`` to ``py27``. We've made jobs for each of the common tox environments. @@ -930,11 +930,11 @@ changed files. You can define for a job either a list of ``irrelevant-files`` or a list of ``files``. Do not use both together. See the `Zuul User Guide -`_ +`_ for more information on how jobs are configured. .. _Project Testing Interface: https://governance.openstack.org/tc/reference/project-testing-interface.html -.. _Zuul v3 documentation: https://docs.openstack.org/infra/zuul +.. _Zuul v3 documentation: https://zuul-ci.org/docs/zuul/ .. _openstack-zuul-jobs documentation: https://docs.openstack.org/infra/openstack-zuul-jobs/ .. _openstack-zuul-jobs jobs.yaml: https://git.openstack.org/cgit/openstack-infra/openstack-zuul-jobs/tree/zuul.d/jobs.yaml .. _openstack-zuul-jobs roles: https://git.openstack.org/cgit/openstack-infra/openstack-zuul-jobs/tree/roles @@ -944,7 +944,7 @@ for more information on how jobs are configured. .. _playbooks/legacy: https://git.openstack.org/cgit/openstack-infra/openstack-zuul-jobs/tree/playbooks/legacy .. _project-config zuul.d: https://git.openstack.org/cgit/openstack-infra/project-config/tree/zuul.d .. _project-config: https://git.openstack.org/cgit/openstack-infra/project-config -.. _zuul-jobs documentation: https://docs.openstack.org/infra/zuul-jobs/ +.. _zuul-jobs documentation: https://zuul-ci.org/docs/zuul-jobs/ .. _zuul-jobs roles: https://git.openstack.org/cgit/openstack-infra/zuul-jobs/tree/roles .. _zuul-jobs zuul.yaml: https://git.openstack.org/cgit/openstack-infra/zuul-jobs/tree/zuul.yaml .. _zuul-jobs: https://git.openstack.org/cgit/openstack-infra/zuul-jobs