diff --git a/doc/common/glossary.rst b/doc/common/glossary.rst index 2b06d04c8f..c5e79dcc90 100644 --- a/doc/common/glossary.rst +++ b/doc/common/glossary.rst @@ -9,7 +9,7 @@ vocabulary for OpenStack-related concepts. To add to OpenStack glossary, clone the `openstack/openstack-manuals repository -`__ and +`__ and update the source file ``doc/common/glossary.rst`` through the OpenStack contribution process. diff --git a/doc/doc-contrib-guide/source/api-guides.rst b/doc/doc-contrib-guide/source/api-guides.rst index 1b383559a9..5a8f90d651 100644 --- a/doc/doc-contrib-guide/source/api-guides.rst +++ b/doc/doc-contrib-guide/source/api-guides.rst @@ -38,8 +38,8 @@ If your project does not have any documentation, you can find a suggested outline in the `API documentation guidelines`_. The Compute project has examples to follow: -* `OpenStack nova api-guide `_ -* `OpenStack nova api-ref `_ +* `OpenStack nova api-guide `_ +* `OpenStack nova api-ref `_ For service names, you must adhere to the official name for the service as indicated in the governance repository in the ``reference/projects.yaml`` @@ -166,8 +166,8 @@ The basic steps are: $ tox -e api-ref #. Add the ``api-ref-jobs`` template to your project, patch the - `zuul.d/projects.yaml `__ - file stored in ``openstack-infra/project-config`` repository. + `zuul.d/projects.yaml `__ + file stored in ``openstack/project-config`` repository. After the source files and build jobs exist, the docs are built to `developer.openstack.org`_. @@ -188,12 +188,12 @@ documentation, patch the ``reference/projects.yaml`` file in the .. _`developer.openstack.org`: https://developer.openstack.org .. _`wadl2rst`: https://github.com/annegentle/wadl2rst .. _`Compute API Guide`: https://developer.openstack.org/api-guide/compute -.. _`example patch`: https://review.openstack.org/#/c/233446/ +.. _`example patch`: https://review.opendev.org/#/c/233446/ .. _`API documentation guidelines`: https://specs.openstack.org/openstack/api-wg/guidelines/api-docs.html .. _`microversions`: https://developer.openstack.org/api-guide/compute/microversions.html .. _`API Quick Start page`: https://developer.openstack.org/api-guide/quick-start/ .. _`cycle-with-milestones release model`: https://releases.openstack.org/reference/release_models.html#cycle-with-milestones .. _`nova example`: https://github.com/openstack/nova/blob/master/api-ref/source/conf.py -.. _`openstack/api-site repository`: https://git.openstack.org/cgit/openstack/api-site/tree/api-quick-start/source/index.rst -.. _`openstack/governance repository`: https://git.openstack.org/cgit/openstack/governance/tree/reference/projects.yaml +.. _`openstack/api-site repository`: https://opendev.org/openstack/api-site/src/branch/master/api-quick-start/source/index.rst +.. _`openstack/governance repository`: https://opendev.org/openstack/governance/src/branch/master/reference/projects.yaml diff --git a/doc/doc-contrib-guide/source/blueprints-and-specs.rst b/doc/doc-contrib-guide/source/blueprints-and-specs.rst index d88c17040a..f47a52db95 100644 --- a/doc/doc-contrib-guide/source/blueprints-and-specs.rst +++ b/doc/doc-contrib-guide/source/blueprints-and-specs.rst @@ -5,7 +5,7 @@ Blueprints and specifications ============================= The Documentation team uses specifications in the `docs-specs repository -`_ to maintain large +`_ to maintain large changes. Approved specifications are published at `Documentation Program Specifications `_. For tracking purposes, a blueprint is created for each specification. @@ -24,7 +24,7 @@ Use blueprints and specifications: A specification needs two +2 votes from the docs core team. See the current list of `docs core team members -`_. +`_. Use bugs against a particular repository with documentation: diff --git a/doc/doc-contrib-guide/source/doc-impact.rst b/doc/doc-contrib-guide/source/doc-impact.rst index c566e50acb..4a7a882848 100644 --- a/doc/doc-contrib-guide/source/doc-impact.rst +++ b/doc/doc-contrib-guide/source/doc-impact.rst @@ -19,8 +19,8 @@ a deprecated or new feature, a caveat or if you have written docs in the patch, add "DocImpact" to a line in your commit message. This creates a Launchpad bug for the project indicated in the -``gerrit/projects.yaml`` file in the `openstack-infra/project-config -`_ repository. +``gerrit/projects.yaml`` file in the `openstack/project-config +`_ repository. This does not guarantee documentation will be written, but offers visibility of the change and tracking. You can also use it as a reminder to yourself to write docs for the feature later, or remind yourself to find a writer to write for @@ -35,7 +35,7 @@ notification comes to the list. #. In the title, put ``newton`` or ``ocata`` depending on the release the patch affects. - #. Copy and paste the ``review.openstack.org`` link in the bug description. + #. Copy and paste the ``review.opendev.org`` link in the bug description. #. Describe the documentation that is affected if the code patch lands in the bug description. #. Keep the doc bug set to ``New`` until the code patch is merged. diff --git a/doc/doc-contrib-guide/source/doc-tag.rst b/doc/doc-contrib-guide/source/doc-tag.rst index c3e746a6cf..6283b37461 100644 --- a/doc/doc-contrib-guide/source/doc-tag.rst +++ b/doc/doc-contrib-guide/source/doc-tag.rst @@ -12,7 +12,7 @@ Governance tag documentation guidelines The ``docs:follows-policy`` tag indicates that the OpenStack Documentation team and the project team associated with the tagged deliverable verify that the project's documentation in the `openstack-manuals -`_ +`_ repository is accurate and current. Definition @@ -53,7 +53,7 @@ The project team either: *or* * provides a fix to the `openstack-manuals - `_ + `_ repo. If patch is submitted, this action would require an additional +1 by the relevant project team for such issues before approval. @@ -69,7 +69,7 @@ the team project and either: *or* * provides a fix to the `openstack-manuals - `_ + `_ repo. If patch is submitted, this action would require an additional +1 by the relevant project team for such issues before approval. diff --git a/doc/doc-contrib-guide/source/doc-tools/template-generator.rst b/doc/doc-contrib-guide/source/doc-tools/template-generator.rst index 65f9c6bd48..b0d84e1cb6 100644 --- a/doc/doc-contrib-guide/source/doc-tools/template-generator.rst +++ b/doc/doc-contrib-guide/source/doc-tools/template-generator.rst @@ -236,7 +236,7 @@ The ``type`` must be one of the values listed below: An entry can also optionally define ``service_type``, which must match the value associated with the name in the `service-types-authority repository -`_. +`_. Entries with ``type`` set to ``client`` should include a ``description`` field with a short description, such as "keystone client". diff --git a/doc/doc-contrib-guide/source/docs-builds.rst b/doc/doc-contrib-guide/source/docs-builds.rst index cd0dbfacdd..798c33ffae 100644 --- a/doc/doc-contrib-guide/source/docs-builds.rst +++ b/doc/doc-contrib-guide/source/docs-builds.rst @@ -131,7 +131,7 @@ openstack-manuals, run the following command: The individual Tox jobs you can run are explained in detail in the `README file -`_ +`_ in the repository. As a part of the review process, the OpenStack CI system runs scripts @@ -171,7 +171,7 @@ To build a patch locally: Where the value of ``PATCH_ID`` is a Gerrit commit number. You can find this number on the patch link, - ``https://review.openstack.org/#/c/PATCH_ID``. + ``https://review.opendev.org/#/c/PATCH_ID``. #. Build the documentation affected by changes in the patch set. For more information, see :ref:`docs_builds_manuals` and @@ -183,7 +183,7 @@ Build jobs ~~~~~~~~~~ The build jobs for documentation are stored in the -`Project config `_ +`project-config `_ repository. The build jobs build to the docs.openstack.org and developer.openstack.org sites, copying built files via FTP. diff --git a/doc/doc-contrib-guide/source/docs-review.rst b/doc/doc-contrib-guide/source/docs-review.rst index f9976adf7d..927bce21ea 100644 --- a/doc/doc-contrib-guide/source/docs-review.rst +++ b/doc/doc-contrib-guide/source/docs-review.rst @@ -16,7 +16,7 @@ Dashboard is organized in groups based on the audience for the documentation. To see current proposed changes, make sure you register and log into `review.openstack Code Review -`_. For more details on the review process in +`_. For more details on the review process in OpenStack, see `Code Review `_. diff --git a/doc/doc-contrib-guide/source/project-deploy-guide.rst b/doc/doc-contrib-guide/source/project-deploy-guide.rst index 183e157a79..8f0c1e8914 100644 --- a/doc/doc-contrib-guide/source/project-deploy-guide.rst +++ b/doc/doc-contrib-guide/source/project-deploy-guide.rst @@ -38,7 +38,7 @@ Setting up .. code-block:: console - $ cookiecutter https://git.openstack.org/openstack/installguide-cookiecutter.git --checkout HEAD^1 + $ cookiecutter https://opendev.org/openstack/installguide-cookiecutter.git --checkout HEAD^1 You will be prompted to answer questions to complete the installation. Content is then added to the ``deploy-guide`` directory in the @@ -67,7 +67,7 @@ Setting up #. Add the Python package ``openstackdocstheme`` to the ``test-requirements.txt`` file. Copy the exact requirement line from the `global file - `_: + `_: .. code-block:: none @@ -82,7 +82,7 @@ OpenStack Infra ``project-config`` repository: .. code-block:: console - $ git clone https://git.openstack.org/openstack-infra/project-config + $ git clone https://opendev.org/openstack/project-config #. In ``jenkins/jobs/projects.yaml``, add ``deploy-guide-jobs`` within the entry for your project: @@ -142,4 +142,4 @@ Usage for the deploy guide is as follows: For an example, and more information, please review the following OpenStack-Ansible patch: `Add conditional branch names for docs links -`_ +`_ diff --git a/doc/doc-contrib-guide/source/project-install-guide.rst b/doc/doc-contrib-guide/source/project-install-guide.rst index 709109652e..37d8467c74 100644 --- a/doc/doc-contrib-guide/source/project-install-guide.rst +++ b/doc/doc-contrib-guide/source/project-install-guide.rst @@ -42,7 +42,7 @@ Set up project specific installation guides: .. code-block:: console - $ cookiecutter https://git.openstack.org/openstack/installguide-cookiecutter.git + $ cookiecutter https://opendev.org/openstack/installguide-cookiecutter.git You will be prompted to answer the following questions to complete the installation: @@ -85,7 +85,7 @@ Set up project specific installation guides: #. Add the python package ``openstackdocstheme`` to the ``test-requirements.txt`` file. Copy the exact requirement line from the `global file - `_: + `_: .. code-block:: none @@ -109,7 +109,7 @@ After these changes have merged, you can set up the jobs for building. .. code-block:: console - $ git clone https://git.openstack.org/openstack-infra/project-config + $ git clone https://opendev.org/openstack/project-config #. In ``jenkins/jobs/projects.yaml``, add ``install-guide-jobs`` within the entry for your project: diff --git a/doc/doc-contrib-guide/source/quickstart/first-timers.rst b/doc/doc-contrib-guide/source/quickstart/first-timers.rst index ee28221443..a13b6a7c62 100644 --- a/doc/doc-contrib-guide/source/quickstart/first-timers.rst +++ b/doc/doc-contrib-guide/source/quickstart/first-timers.rst @@ -98,7 +98,7 @@ Set up SSH $ notepad ~/.ssh/id_rsa.pub -#. Sign into gerrit at https://review.openstack.org/. +#. Sign into gerrit at https://review.opendev.org/. #. In the upper right, click your username. Click the `Settings > SSH Public Keys`_ page. Click ``Add Key``. Paste the key in the ``Add SSH Public Key`` @@ -143,12 +143,12 @@ Committing a change #. Create your commit message. See `Committing a change`_ for details. -#. Create a patch for review.openstack.org following the `Submitting a Change +#. Create a patch for review.opendev.org following the `Submitting a Change for Review`_ instructions. #. Follow the URL returned from ``git-review`` to check your commit:: - https://review.openstack.org/ + https://review.opendev.org/ #. In Gerrit, wait for the automatic Zuul checks to succeed. @@ -165,7 +165,7 @@ they approve the patch. To submit changes to your patch, proceed with the following steps: -#. Copy the commit number from the review.openstack.org URL. +#. Copy the commit number from the review.opendev.org URL. #. At the command line, change into your local copy of the repository. @@ -204,7 +204,7 @@ git and git review The first time that you run :command:`git review`, you might see this error:: - The authenticity of host '[review.openstack.org]:29418 ([198.101.231.251]:29418) can't be established. + The authenticity of host '[review.opendev.org]:29418 ([104.130.246.32]:29418) can't be established. Type *yes* (all three letters) at the prompt. @@ -218,7 +218,7 @@ git and git review Enter your gerrit username: Enter the user name that matches the user name in the :guilabel:`Settings` - page at review.openstack.org. + page at review.opendev.org. * Not a git repository error @@ -235,11 +235,11 @@ git and git review We don't know where your gerrit is. Please manually create a remote named "gerrit" and try again. - You need to make a git remote that maps to the review.openstack.org SSH port + You need to make a git remote that maps to the review.opendev.org SSH port for your repository. For example, for a user with the ``username_example`` user name and the openstack-manuals repository, you should run this command:: - git remote add gerrit ssh://username_example@review.openstack.org:29418/openstack/openstack-manuals.git + git remote add gerrit ssh://username_example@review.opendev.org:29418/openstack/openstack-manuals.git * Remote rejected error @@ -248,7 +248,7 @@ git and git review ! [remote rejected] HEAD -> refs/publish/master/addopenstackdocstheme (missing Change-Id in commit message footer) The first time you set up a gerrit remote and try to create a patch for - review.openstack.org, you may see this message because the tool needs one + review.opendev.org, you may see this message because the tool needs one more edit of your commit message in order to automatically insert the *Change-Id*. When this happens, run :command:`git commit -a --amend`, save the commit message and run :command:`git review -v` again. @@ -262,10 +262,10 @@ git and git review Permission denied (publickey). Double check the :guilabel:`Settings` page at - https://review.openstack.org/ + https://review.opendev.org/ to make sure your public key on the computer or virtual server has been copied to SSH public keys on - `SSH Public Keys `_. + `SSH Public Keys `_. If you have not adjusted your ``.ssh`` configuration, your system may not be connecting using the correct key for gerrit. @@ -375,8 +375,8 @@ instead: .. _`Python 2.7 environment`: http://docs.python-guide.org/en/latest/starting/install/win/ .. _`79 characters maximum`: https://www.python.org/dev/peps/pep-0008/#maximum-line-length .. _`GitHub help`: https://help.github.com/articles/set-up-git -.. _`Settings page on gerrit`: https://review.openstack.org/#/settings/ -.. _`Settings > SSH Public Keys`: https://review.openstack.org/#/settings/ssh-keys +.. _`Settings page on gerrit`: https://review.opendev.org/#/settings/ +.. _`Settings > SSH Public Keys`: https://review.opendev.org/#/settings/ssh-keys .. _`Starting Work on a New Project`: https://docs.openstack.org/infra/manual/developers.html#starting-work-on-a-new-project .. _`Starting a Change`: https://docs.openstack.org/infra/manual/developers.html#starting-a-change .. _`Committing a change`: https://docs.openstack.org/infra/manual/developers.html#committing-a-change diff --git a/doc/doc-contrib-guide/source/redirects.rst b/doc/doc-contrib-guide/source/redirects.rst index fd126d7109..9760740e2c 100644 --- a/doc/doc-contrib-guide/source/redirects.rst +++ b/doc/doc-contrib-guide/source/redirects.rst @@ -52,7 +52,7 @@ This file will ensure redirects are in place for paths such as ``/nova/latest/aggregates.html`` to ``/nova/latest/user/aggregates.html``, and ``/nova/latest/cells.html`` to ``/nova/latest/user/cells.html``. -__ https://review.openstack.org/#/c/487932/5/doc/source/conf.py +__ https://review.opendev.org/#/c/487932/5/doc/source/conf.py Enable detailed redirects for your project ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -105,7 +105,7 @@ explicit call to **whereto** in your project's ``tox.ini`` file. (This `glance-specs patch`_ provides an example.) .. _whereto: https://docs.openstack.org/whereto/latest/ -.. _glance-specs patch: https://review.openstack.org/#/c/523472/2/tox.ini +.. _glance-specs patch: https://review.opendev.org/#/c/523472/2/tox.ini .. _git-redirect-generation: diff --git a/doc/doc-contrib-guide/source/release/release-tools.rst b/doc/doc-contrib-guide/source/release/release-tools.rst index 9bfe77bd4f..0cd7aeb02a 100644 --- a/doc/doc-contrib-guide/source/release/release-tools.rst +++ b/doc/doc-contrib-guide/source/release/release-tools.rst @@ -14,4 +14,4 @@ For the steps required to trigger a release, see the openstack/releases `README For a review example triggering a new package release, see `Change 448891: Release openstackdocstheme 1.7.0 -`_. +`_. diff --git a/doc/doc-contrib-guide/source/release/taskdetail.rst b/doc/doc-contrib-guide/source/release/taskdetail.rst index 53f36825f9..0081856bba 100644 --- a/doc/doc-contrib-guide/source/release/taskdetail.rst +++ b/doc/doc-contrib-guide/source/release/taskdetail.rst @@ -29,7 +29,7 @@ offers an overview of currently open changes that touch files under ``doc/source/install/`` in project team repositories. .. _`Installation Guides Review Inbox`: - https://review.openstack.org/#/dashboard/?foreach=file%3A%22%5Edoc%5C%2Fsou + https://review.opendev.org/#/dashboard/?foreach=file%3A%22%5Edoc%5C%2Fsou rce%5C%2Finstall%5C%2F.%2A%22%0Astatus%3Aopen%0ANOT+owner%3Aself%0ANOT+labe l%3AWorkflow%3C%3D%2D1%0Alabel%3AVerified%3E%3D1%2Czuul%0ANOT+reviewedby%3A self&title=Installation+Guides+Review+Inbox&Needs+final+%2B2=label%3ACode%2 diff --git a/doc/doc-contrib-guide/source/rst-conv/source-code.rst b/doc/doc-contrib-guide/source/rst-conv/source-code.rst index 6b475e1aeb..ed226996c0 100644 --- a/doc/doc-contrib-guide/source/rst-conv/source-code.rst +++ b/doc/doc-contrib-guide/source/rst-conv/source-code.rst @@ -158,7 +158,7 @@ content from a remote URL (``http`` or ``https``). .. remote-code-block:: ini - https://git.openstack.org/cgit/openstack/nova/tree/etc/nova/api-paste.ini?h=stable/ocata + https://opendev.org/openstack/nova/src/branch/stable/ocata/etc/nova/api-paste.ini **Output** diff --git a/doc/doc-contrib-guide/source/team-structure.rst b/doc/doc-contrib-guide/source/team-structure.rst index d4d7f54802..5b43d93db2 100644 --- a/doc/doc-contrib-guide/source/team-structure.rst +++ b/doc/doc-contrib-guide/source/team-structure.rst @@ -26,7 +26,7 @@ with their respective leads: The current list of docs cores for openstack-manuals, openstackdocstheme, and openstack-doc-tools repositories can be found at -https://review.openstack.org/#/admin/groups/30,members. +https://review.opendev.org/#/admin/groups/30,members. The api-site, contributor-guide, security-doc, training-guides, and training-labs repositories have separate core teams but also include the diff --git a/doc/doc-contrib-guide/source/writing-style/openstack-components.rst b/doc/doc-contrib-guide/source/writing-style/openstack-components.rst index 7f5ffbe042..3669b4b0c0 100644 --- a/doc/doc-contrib-guide/source/writing-style/openstack-components.rst +++ b/doc/doc-contrib-guide/source/writing-style/openstack-components.rst @@ -18,5 +18,5 @@ For more information, see `Service and Project Naming in OpenStack Technical Committee governance documents. The official source for services and project names is in the -`projects.yaml `_ +`projects.yaml `_ file in the ``openstack/governance`` repository. diff --git a/doc/image-guide/source/create-images-automatically.rst b/doc/image-guide/source/create-images-automatically.rst index 993f042de1..2b7e585899 100644 --- a/doc/image-guide/source/create-images-automatically.rst +++ b/doc/image-guide/source/create-images-automatically.rst @@ -32,7 +32,7 @@ variables or adding elements to the command-line: This example creates the image as before, but for arm architecture. More elements are available in the `git source directory -`_ +`_ and documented in the `diskimage-builder elements documentation `_. diff --git a/releasenotes/source/newton.rst b/releasenotes/source/newton.rst index 5141b517a8..52b3d4dbd6 100644 --- a/releasenotes/source/newton.rst +++ b/releasenotes/source/newton.rst @@ -98,7 +98,7 @@ Installation guide service (magnum), Messaging service (zaqar), Key Manager service (barbican), and Bare Metal service (ironic). -* Created `cookiecutter `_ +* Created `cookiecutter `_ tool to ensure project specific guides have a consistent structure. Networking guide diff --git a/tools/README-USE-openstack-doc-tools.txt b/tools/README-USE-openstack-doc-tools.txt index 9d8b1381d5..e5ea027a72 100644 --- a/tools/README-USE-openstack-doc-tools.txt +++ b/tools/README-USE-openstack-doc-tools.txt @@ -1,7 +1,7 @@ The tools directory has been moved to a separate repository, openstack-doc-tools: -https://git.openstack.org/cgit/openstack/openstack-doc-tools +https://opendev.org/openstack/openstack-doc-tools Please do not make changes here, commit instead to openstack-doc-tools unless you need those for gating jobs.