From 23603bd76268c20d012d181be5a01cc08e36ce34 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Tue, 25 Apr 2017 21:36:18 +0200 Subject: [PATCH] Use https in many more places Many sites redirect http URLs to https, use https in our documentation for these. Change-Id: I7e3ef3c3b65ff42be7f167decf53eca314256c15 --- doc/source/creators.rst | 22 +++++++++++----------- doc/source/developers.rst | 8 ++++---- doc/source/drivers.rst | 22 +++++++++++----------- doc/source/index.rst | 4 ++-- doc/source/python.rst | 2 +- doc/source/sandbox.rst | 2 +- 6 files changed, 30 insertions(+), 30 deletions(-) diff --git a/doc/source/creators.rst b/doc/source/creators.rst index 9da8a48..d7121d5 100644 --- a/doc/source/creators.rst +++ b/doc/source/creators.rst @@ -40,10 +40,10 @@ Note that only official OpenStack projects may use certain parts of the OpenStack infrastructure, especially the docs.openstack.org and specs.openstack.org server. -.. _governance site: http://governance.openstack.org -.. _OpenStack Project Teams: http://governance.openstack.org/reference/projects/index.html -.. _Project Team Guide: http://docs.openstack.org/project-team-guide/ -.. _StackForge: http://docs.openstack.org/infra/system-config/stackforge.html +.. _governance site: https://governance.openstack.org +.. _OpenStack Project Teams: https://governance.openstack.org/reference/projects/index.html +.. _Project Team Guide: https://docs.openstack.org/project-team-guide/ +.. _StackForge: https://docs.openstack.org/infra/system-config/stackforge.html Choosing a Good Name for Your Project ===================================== @@ -132,7 +132,7 @@ Put Your New Project in the Correct Project Group If your project is not an official OpenStack project, this step is optional. #. From the Overview page of your project, select "Change Details" - from the right sidebar (http://launchpad.net//+edit). + from the right sidebar (https://launchpad.net//+edit). #. Find the "Part of" field and set the value to "openstack" for integrated projects and "oslo" for Oslo libraries. @@ -675,7 +675,7 @@ channel, add it to the ``openstack-oslo`` section:: - master If you're adding a new IRC channel, see the `IRC -services `_ documentation. +services `_ documentation. Submitting Infra Change for Review ---------------------------------- @@ -741,7 +741,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: http://governance.openstack.org/reference/tags/index.html +.. _list of currently allowed tags: https://governance.openstack.org/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 @@ -1078,7 +1078,7 @@ Add Link to Your Developer Documentation If your project is not an official OpenStack project, skip this section. -Update the http://docs.openstack.org/developer/openstack-projects.html +Update the https://docs.openstack.org/developer/openstack-projects.html page with a link to your documentation by checking out the ``openstack/openstack-manuals`` repository and editing ``www/developer/openstack-projects.html``. @@ -1091,8 +1091,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: http://docs.openstack.org/developer/oslo.i18n -.. _guidelines: http://docs.openstack.org/developer/oslo.i18n/guidelines.html +.. _oslo.i18n: https://docs.openstack.org/developer/oslo.i18n +.. _guidelines: https://docs.openstack.org/developer/oslo.i18n/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 @@ -1380,5 +1380,5 @@ 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 http://pypi.python.org +#. Will the repo release on pypi? Check that it https://pypi.python.org is set up correctly. diff --git a/doc/source/developers.rst b/doc/source/developers.rst index 05f6b28..4fbf7d4 100644 --- a/doc/source/developers.rst +++ b/doc/source/developers.rst @@ -807,7 +807,7 @@ If a change fails tests in Jenkins, please follow the steps below: CI infrastructure by doing the following: * https://wiki.openstack.org/wiki/Infrastructure_Status - * `@OpenStackInfra `_ on Twitter. + * `@OpenStackInfra `_ on Twitter. * the topic in your project's IRC channel (or ``#openstack-infra``) .. note:: @@ -851,7 +851,7 @@ If a change fails tests in Jenkins, please follow the steps below: 7. If a nice message from Elastic Recheck didn't show up in your change when a test in a gate job failed, and you've identified a bug to recheck against, you can help out by writing an `elastic-recheck - query `_ + query `_ for the bug. A patchset has to be approved to run tests in the gate pipeline. If the @@ -1063,6 +1063,6 @@ other repositories can be identified. Additional information about project gating and Zuul can be found in the Zuul documentation, located at: -http://docs.openstack.org/infra/zuul/gating.html +https://docs.openstack.org/infra/zuul/gating.html -.. _`Running Python Unit Tests`: http://docs.openstack.org/project-team-guide/project-setup/python.html#running-python-unit-tests +.. _`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 a57bed9..6c70fd3 100644 --- a/doc/source/drivers.rst +++ b/doc/source/drivers.rst @@ -13,7 +13,7 @@ on a feature branch rather than on master. In particular it organizes work to a location that interested parties can follow. Feature branches also move merge points to specific points in time rather than at every proposed change. Learn more about `feature branches in the project team -guide `_. +guide `_. To get started with a feature branch you will need to create the new branch in Gerrit with the 'feature/' prefix. Note that Gerrit ACLs do @@ -120,7 +120,7 @@ Projects following the release:cycle-with-milestones model generate release candidates before the final release to encourage 3rd-party testing. The first release candidate (RC1) is cut from the master branch. You can learn more about `release management in the project -team guide `_. +team guide `_. Between RC1 and the final release, there needs to be a separate branch in Gerrit for release-critical changes destined for the final @@ -209,7 +209,7 @@ If there are conflicts when cherry-picking, do not delete the to reviewers to identify files which need extra attention. You can learn more about `stable branches in the project team guide -`_. +`_. Tagging a Release ~~~~~~~~~~~~~~~~~ @@ -271,7 +271,7 @@ Before you can configure GerritBot, you need to give channel permissions with an accessbot configuration specific to the channel where you want notifications posted. The configuration file is hosted in `openstack-infra/project-config -`_. Edit +`_. Edit ``accessbot/channels.yaml`` to add your IRC channel if it is not already listed. @@ -280,7 +280,7 @@ project you are configuring, you need to add your GerritBot configuration into ``gerritbot/channels.yaml``. This file is hosted in `openstack-infra/project-config -`_. +`_. The syntax for configuring the notifications is:: @@ -305,7 +305,7 @@ Running Jobs with Zuul There are two major components in getting jobs running under Zuul. First you must ensure that the job you want to run is defined in the `JJB config `_. -The `JJB documentation `_ +The `JJB documentation `_ is extensive as are the examples in our JJB config so we will not cover that here. @@ -386,7 +386,7 @@ then invoke from all of the related projects. This way they all run the same job (which tests the entire system) and Zuul knows to combine those projects into a shared change queue. -Zuul comes with extensive `documentation `_ +Zuul comes with extensive `documentation `_ too and should be referenced for more information. Retiring a Project @@ -513,20 +513,20 @@ 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 +`_). 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 run devstack based tests, then list missing binary packages below the `files -`_ +`_ directory of devstack. For non-devstack based tests, add a ``bindep.txt`` file containing listing the required distribution packages. It is a cross-platform list of all dependencies needed for running tests. The -`bindep `_ utility will be +`bindep `_ utility will be used to install the right dependencies per distribution when running in the OpenStack CI infrastructure. @@ -555,7 +555,7 @@ missing binary packages. The OpenStack CI infrastructure will install packages marked for a `profile -`__ named +`__ named "test" along with any packages belonging to the default profile of the ``bindep.txt`` file. Add any build time requirements and any requirements specific to the test jobs to the "test" profile, add diff --git a/doc/source/index.rst b/doc/source/index.rst index e8ab18e..d18ae1b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -12,7 +12,7 @@ OpenStack project. If you are not trying to contribute to OpenStack directly, but are instead a user or developer looking for API documentation, see -`OpenStack documentation `_. +`OpenStack documentation `_. .. important:: @@ -20,7 +20,7 @@ instead a user or developer looking for API documentation, see * https://wiki.openstack.org/wiki/Infrastructure_Status * `@OpenStackInfra - `_ on Twitter. + `_ on Twitter. * the topic in IRC If you notice problems, report them via #openstack-infra on IRC or diff --git a/doc/source/python.rst b/doc/source/python.rst index fdc338f..4eb3b83 100644 --- a/doc/source/python.rst +++ b/doc/source/python.rst @@ -6,4 +6,4 @@ Python Developer's Guide This document has been moved to the `Project Team Guide: Python Project Guide`_. -.. _`Project Team Guide: Python Project Guide`: http://docs.openstack.org/project-team-guide/project-setup/python.html +.. _`Project Team Guide: Python Project Guide`: https://docs.openstack.org/project-team-guide/project-setup/python.html diff --git a/doc/source/sandbox.rst b/doc/source/sandbox.rst index 6c505ae..2469764 100644 --- a/doc/source/sandbox.rst +++ b/doc/source/sandbox.rst @@ -76,7 +76,7 @@ submitted for review and a URL to your change on https://review.openstack.org. Click on the URL and view your patchset. You will also receive one or more emails from the -`automatic testing system `_, +`automatic testing system `_, reporting the testing results of your newly committed change. Now create a second patchset, in the same git branch as your first patchset.