From c67079cd61ca9264b2f503f6514faa4cc6066a29 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 19 Mar 2020 17:31:48 +0100 Subject: [PATCH] Redirect infra-manual The infra-manual now lives on docs.opendev.org, update links and add a redirect. New location is: https://docs.opendev.org/opendev/infra-manual/latest/ For the Contribute footer, point to Contributors Guide. Depends-On: https://review.opendev.org/713925 Depends-On: https://review.opendev.org/713929 Change-Id: I73e3c07e16fc7ef0157f47ffd510a0cc68cee060 --- CONTRIBUTING.rst | 4 ++-- .../source/doc-tools/contributing.rst | 4 ++-- doc/doc-contrib-guide/source/docs-builds.rst | 4 ++-- doc/doc-contrib-guide/source/docs-review.rst | 10 ++++----- .../source/quickstart/first-timers.rst | 22 +++++++++---------- www/.htaccess | 5 +++++ www/redirect-tests.txt | 5 +++++ www/templates/footer.tmpl | 2 +- 8 files changed, 33 insertions(+), 23 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 4dcd01fe4e..2b75a68dda 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -21,14 +21,14 @@ If you would like to contribute to the documents, please see the If you would like to contribute to the development of OpenStack, you must follow the steps in this page: - https://docs.openstack.org/infra/manual/developers.html + https://docs.opendev.org/opendev/infra-manual/latest/developers.html If you already have a good understanding of how the system works and your OpenStack accounts are set up, you can skip to the development workflow section of this documentation to learn how changes to OpenStack should be submitted for review via the Gerrit tool: - https://docs.openstack.org/infra/manual/developers.html#development-workflow + https://docs.opendev.org/opendev/infra-manual/latest/developers.html#development-workflow Pull requests submitted through GitHub will be ignored. diff --git a/doc/doc-contrib-guide/source/doc-tools/contributing.rst b/doc/doc-contrib-guide/source/doc-tools/contributing.rst index 7ecec86bfd..2634fb3c78 100644 --- a/doc/doc-contrib-guide/source/doc-tools/contributing.rst +++ b/doc/doc-contrib-guide/source/doc-tools/contributing.rst @@ -12,7 +12,7 @@ To contribute to the development of ``openstack-doc-tools``, proceed with the following steps: #. Complete the procedures described - in the `Developers Guide `_. + in the `Developers Guide `_. #. Follow `OpenStack Style Commandments `_ while developing improvements for the tool. @@ -23,7 +23,7 @@ the following steps: and ``bashate`` tests. A test suite would be welcome. #. Submit your change for review through the Gerrit tool as described - in the `gerrit workflow `_. + in the `gerrit workflow `_. .. warning:: diff --git a/doc/doc-contrib-guide/source/docs-builds.rst b/doc/doc-contrib-guide/source/docs-builds.rst index 5ecc609be1..2c34015802 100644 --- a/doc/doc-contrib-guide/source/docs-builds.rst +++ b/doc/doc-contrib-guide/source/docs-builds.rst @@ -12,7 +12,7 @@ files reside. For the instructions on how to clone a repository so that you can work on it locally, refer to the `Starting Work on a New Project -`_ +`_ of the Infrastructure manual. See :ref:`troubleshoot_setup` if you have difficulty with a repository @@ -51,7 +51,7 @@ in the repository. clone if you want to build the documentation. For more information on ``bindep`` and packages, see `Package Requirements - `_. + `_. * On Ubuntu or Debian: diff --git a/doc/doc-contrib-guide/source/docs-review.rst b/doc/doc-contrib-guide/source/docs-review.rst index 0d6b04f864..cb8759cced 100644 --- a/doc/doc-contrib-guide/source/docs-review.rst +++ b/doc/doc-contrib-guide/source/docs-review.rst @@ -18,7 +18,7 @@ To see current proposed changes, make sure you register and log into `review.openstack Code Review `_. For more details on the review process in OpenStack, see `Code Review -`_. +`_. Review guidelines ~~~~~~~~~~~~~~~~~ @@ -44,7 +44,7 @@ Reviewing a documentation patch Before you proceed with reviewing patches, make sure to read carefully the :doc:`Review Guidelines ` for documentation and `Code Review Guidelines -`_. +`_. Once done, follow the steps below to submit a patch review. #. If you want to review patches for the repositories managed by the @@ -75,12 +75,12 @@ Once done, follow the steps below to submit a patch review. A patch with WorkInProgress (WIP) status needs additional work before review and possible approval. Therefore, you may skip such a patch and review once it is ready. For more information, see `Work In Progress - `_. + `_. .. seealso:: `Peer Review - `_ + `_ .. note:: @@ -135,7 +135,7 @@ unfavorable gets through, without discouraging contributions. General instructions for being a core reviewer are located in the `Core Reviewer's Guide -`_. +`_. This section is for openstack-manuals core reviewers. In almost all cases, patches can be merged with at least one +1 vote, and diff --git a/doc/doc-contrib-guide/source/quickstart/first-timers.rst b/doc/doc-contrib-guide/source/quickstart/first-timers.rst index a13b6a7c62..2b8a542ebe 100644 --- a/doc/doc-contrib-guide/source/quickstart/first-timers.rst +++ b/doc/doc-contrib-guide/source/quickstart/first-timers.rst @@ -285,7 +285,7 @@ git and git review state of the repository. In many cases, this can be achieved by pressing the ``Rebase`` button in the gerrit interface. If this fails, you must `rebase manually - `_. + `_. For a basic introduction to solving merge conflicts, see the GitHub article `Resolving merge conflicts after a git rebase @@ -303,7 +303,7 @@ git and git review leaving the word *recheck* in the comments section of your Gerrit review. - .. seealso:: * `Automated Testing `_ + .. seealso:: * `Automated Testing `_ * :ref:`build_jobs` Network @@ -322,7 +322,7 @@ Try again when your network connection improves. If you suspect that SSH over non-standards ports might be blocked or need to access the web using http/https, you can configure git-review to `use an https endpoint instead of ssh -`_ +`_ as explained in the Infrastructure Manual. Python @@ -363,11 +363,11 @@ instead: .. Links -.. _`Sign the appropriate Individual Contributor License Agreement`: https://docs.openstack.org/infra/manual/developers.html#sign-the-appropriate-individual-contributor-license-agreement -.. _`Installing git-review`: https://docs.openstack.org/infra/manual/developers.html#install-the-git-review-utility +.. _`Sign the appropriate Individual Contributor License Agreement`: https://docs.opendev.org/opendev/infra-manual/latest/developers.html#sign-the-appropriate-individual-contributor-license-agreement +.. _`Installing git-review`: https://docs.opendev.org/opendev/infra-manual/latest/developers.html#install-the-git-review-utility .. _`OpenStack Documentation Bug Team`: https://launchpad.net/~openstack-doc-bugs .. _`OpenStack Foundation`: https://www.openstack.org/join -.. _`Development Workflow`: https://docs.openstack.org/infra/manual/developers.html#development-workflow +.. _`Development Workflow`: https://docs.opendev.org/opendev/infra-manual/latest/developers.html#development-workflow .. _`git`: http://msysgit.github.io .. _`curl`: http://curl.haxx.se/ .. _`tar`: http://gnuwin32.sourceforge.net/packages/gtar.htm @@ -377,9 +377,9 @@ instead: .. _`GitHub help`: https://help.github.com/articles/set-up-git .. _`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 -.. _`Submitting a Change for Review`: https://docs.openstack.org/infra/manual/developers.html#submitting-a-change-for-review -.. _`Updating a Change`: https://docs.openstack.org/infra/manual/developers.html#updating-a-change +.. _`Starting Work on a New Project`: https://docs.opendev.org/opendev/infra-manual/latest/developers.html#starting-work-on-a-new-project +.. _`Starting a Change`: https://docs.opendev.org/opendev/infra-manual/latest/developers.html#starting-a-change +.. _`Committing a change`: https://docs.opendev.org/opendev/infra-manual/latest/developers.html#committing-a-change +.. _`Submitting a Change for Review`: https://docs.opendev.org/opendev/infra-manual/latest/developers.html#submitting-a-change-for-review +.. _`Updating a Change`: https://docs.opendev.org/opendev/infra-manual/latest/developers.html#updating-a-change diff --git a/www/.htaccess b/www/.htaccess index ee20dda0f4..e0ec8d5693 100644 --- a/www/.htaccess +++ b/www/.htaccess @@ -259,3 +259,8 @@ redirectmatch 301 /infra/nodepool/feature/zuulv3(.*)$ https://zuul-ci.org/docs/n # Redirect outdated bare metal installation guide {{ deep_links('/project-install-guide/baremetal/draft', '/ironic/latest/install/$1') }} # End redirect outdated bare metal installation guide + +# Redirect https://docs.openstack.org/infra/manual to +# https://docs.opendev.org/infra-manual +{{ deep_links('/infra/manual', 'https://docs.opendev.org/opendev/infra-manual/latest/$1') }} +# End redirect infra-manual diff --git a/www/redirect-tests.txt b/www/redirect-tests.txt index b145cba4ea..b3738b52fc 100644 --- a/www/redirect-tests.txt +++ b/www/redirect-tests.txt @@ -285,3 +285,8 @@ # Redirect outdated bare metal installation guide {{ deep_links('/project-install-guide/baremetal/draft', '/ironic/latest/install') }} # End redirect outdated bare metal installation guide + +# Redirect https://docs.openstack.org/infra/manual to +# https://docs.opendev.org/infra-manual +{{ deep_links('/infra/manual', 'https://docs.opendev.org/opendev/infra-manual/latest') }} +# End redirect infra-manual diff --git a/www/templates/footer.tmpl b/www/templates/footer.tmpl index fe36de0981..6a39a9e2cf 100644 --- a/www/templates/footer.tmpl +++ b/www/templates/footer.tmpl @@ -27,7 +27,7 @@ href="https://www.openstack.org/community/jobs/">Jobs
  • Companies
  • Contribute
    • +href="/contributors">Contribute
  • Get Swag!