From ca1fe6cc847305d438faff60fef7a7ec60178c72 Mon Sep 17 00:00:00 2001 From: Ruby Loo Date: Tue, 22 Aug 2017 14:43:44 -0400 Subject: [PATCH] correct URLs in contributor docs & main index This corrects the URLs in the contributor documentation as well as the main index. The changes include: - changing http to https - changing absolute links to relative links (where applicable) Change-Id: Iea392f8108ca4b5203682609dd78b980c1540b89 --- .../contributor/code-contribution-guide.rst | 26 ++++++++++--------- doc/source/contributor/dev-quickstart.rst | 2 +- doc/source/contributor/faq.rst | 2 ++ doc/source/contributor/governance.rst | 6 ++--- doc/source/contributor/index.rst | 2 +- doc/source/contributor/osprofiler-support.rst | 8 +++--- doc/source/contributor/releasing.rst | 9 +++---- doc/source/contributor/states.rst | 2 +- doc/source/contributor/webapi.rst | 2 +- doc/source/index.rst | 4 +-- 10 files changed, 32 insertions(+), 31 deletions(-) diff --git a/doc/source/contributor/code-contribution-guide.rst b/doc/source/contributor/code-contribution-guide.rst index 2bbb611be2..ac65a35568 100644 --- a/doc/source/contributor/code-contribution-guide.rst +++ b/doc/source/contributor/code-contribution-guide.rst @@ -13,10 +13,10 @@ Getting Started If you're completely new to OpenStack and want to contribute to the ironic project, please start by familiarizing yourself with the `Infra Team's Developer -Guide `_. This will help -you get your accounts set up in Launchpad and Gerrit, familiarize you with the -workflow for the OpenStack continuous integration and testing systems, and help -you with your first commit. +Guide `_. This will +help you get your accounts set up in Launchpad and Gerrit, familiarize you with +the workflow for the OpenStack continuous integration and testing systems, and +help you with your first commit. LaunchPad Project ----------------- @@ -48,13 +48,13 @@ Project Hosting Details ----------------------- Bug tracker - http://launchpad.net/ironic + https://bugs.launchpad.net/ironic Mailing list (prefix Subject line with ``[ironic]``) http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev Wiki - http://wiki.openstack.org/Ironic + https://wiki.openstack.org/Ironic Code Hosting https://git.openstack.org/cgit/openstack/ironic @@ -141,8 +141,10 @@ not be tolerated, and will be called out in public on the mailing list. Live Upgrade Related Concerns ============================= + Ironic implements upgrade with the same methodology of Nova: - http://docs.openstack.org/developer/nova/upgrade.html + + https://docs.openstack.org/nova/latest/user/upgrade.html Ironic API RPC Versions ----------------------- @@ -219,20 +221,20 @@ Ironic Specs Process ==================== Specifications must follow the template which can be found at -`specs/template.rst `_, which is quite self-documenting. Specifications are proposed by adding them to the `specs/approved` directory, adding a soft link to it from the `specs/not-implemented` directory, and posting it for -review to Gerrit. For more information, please see the `README `_. The same `Gerrit process -`_ as with source code, -using the repository `ironic-specs `_ as with source code, +using the repository `ironic-specs `_, is used to add new specifications. All approved specifications are available at: -http://specs.openstack.org/openstack/ironic-specs. If a specification has +https://specs.openstack.org/openstack/ironic-specs. If a specification has been approved but not completed within one or more releases since the approval, it may be re-reviewed to make sure it still makes sense as written. diff --git a/doc/source/contributor/dev-quickstart.rst b/doc/source/contributor/dev-quickstart.rst index 607de22c46..c62133e000 100644 --- a/doc/source/contributor/dev-quickstart.rst +++ b/doc/source/contributor/dev-quickstart.rst @@ -23,7 +23,7 @@ patch. .. seealso:: - http://docs.openstack.org/infra/manual/developers.html#development-workflow + https://docs.openstack.org/infra/manual/developers.html#development-workflow Prepare Development System ========================== diff --git a/doc/source/contributor/faq.rst b/doc/source/contributor/faq.rst index 26abb7673b..bc2d146f1a 100644 --- a/doc/source/contributor/faq.rst +++ b/doc/source/contributor/faq.rst @@ -28,6 +28,8 @@ It will create an empty alembic migration. For more information see the .. _`alembic documentation`: http://alembic.zzzcomputing.com/en/latest/tutorial.html#create-a-migration-script +.. _faq_release_note: + ...know if a release note is needed for my change? -------------------------------------------------- diff --git a/doc/source/contributor/governance.rst b/doc/source/contributor/governance.rst index a74d73cb05..19300a6232 100644 --- a/doc/source/contributor/governance.rst +++ b/doc/source/contributor/governance.rst @@ -6,7 +6,7 @@ The ironic project manages a number of repositories that contribute to our mission. The full list of repositories that ironic manages is available in the `governance site`_. -.. _`governance site`: http://governance.openstack.org/reference/projects/ironic.html +.. _`governance site`: https://governance.openstack.org/reference/projects/ironic.html What belongs in ironic governance? ================================== @@ -14,12 +14,12 @@ What belongs in ironic governance? For a repository to be part of the Ironic project: * It must comply with the TC's `rules for a new project - `_. + `_. * It must not be intended for use with only a single vendor's hardware. A library that implements a standard to manage hardware from multiple vendors (such as IPMI or redfish) is okay. * It must align with Ironic's `mission statement - `_. + `_. Lack of contributor diversity is a chicken-egg problem, and as such a repository where only a single company is contributing is okay, with the hope diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 6390dc42a2..da30a3b0b7 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -66,7 +66,7 @@ Testing Network Integration --------------------------- In order to test the integration between the Bare Metal and Networking -services, support has been added to `devstack `_ +services, support has been added to `devstack `_ to mimic an external physical switch. Here we include a recommended configuration for devstack to bring up this environment. diff --git a/doc/source/contributor/osprofiler-support.rst b/doc/source/contributor/osprofiler-support.rst index 3ce1a6559d..3b844b5a86 100644 --- a/doc/source/contributor/osprofiler-support.rst +++ b/doc/source/contributor/osprofiler-support.rst @@ -46,7 +46,7 @@ How to Use OSProfiler with Ironic in Devstack To use or test OSProfiler in ironic, the user needs to setup Devstack with OSProfiler and ceilometer. In addition to the setup described at -`Deploying Ironic with DevStack`_, the user needs to do the following: +:ref:`deploy_devstack`, the user needs to do the following: Add the following to ``localrc`` to enable OSProfiler and ceilometer:: @@ -120,8 +120,6 @@ References ========== - `OSProfiler – Cross-project profiling library`_ -- `Deploying Ironic with DevStack`_ - -.. _OSProfiler – Cross-project profiling library: http://docs.openstack.org/osprofiler/latest/index.html -.. _Deploying Ironic with DevStack: http://docs.openstack.org/ironic/latest/contributor/dev-quickstart.html#deploying-ironic-with-devstack +- :ref:`deploy_devstack` +.. _OSProfiler – Cross-project profiling library: https://docs.openstack.org/osprofiler/latest/index.html diff --git a/doc/source/contributor/releasing.rst b/doc/source/contributor/releasing.rst index 69a952b285..0273e7f78c 100644 --- a/doc/source/contributor/releasing.rst +++ b/doc/source/contributor/releasing.rst @@ -8,7 +8,7 @@ that process here. A full list of projects that ironic manages is available in the `governance site`_. -.. _`governance site`: http://governance.openstack.org/reference/projects/ironic.html +.. _`governance site`: https://governance.openstack.org/reference/projects/ironic.html Who is responsible for releases? ================================ @@ -28,13 +28,14 @@ Release process Releases are managed by the OpenStack release team. The release process is documented in the `Project Team Guide`_. -.. _`Project Team Guide`: http://docs.openstack.org/project-team-guide/release-management.html#how-to-release +.. _`Project Team Guide`: https://docs.openstack.org/project-team-guide/release-management.html#how-to-release Things to do before releasing ============================= * Review the unreleased release notes, if the project uses them. Make sure - they follow our `standards`_, are coherent, and have proper grammar. + they follow our :ref:`standards `, are coherent, and have + proper grammar. Combine release notes if necessary (for example, a release note for a feature and another release note to add to that feature may be combined). @@ -54,8 +55,6 @@ Things to do before releasing * Regenerate the sample config file, so that the choices for the ``[DEFAULT]/pin_release_version`` configuration are accurate. -.. _`standards`: http://docs.openstack.org/ironic/latest/contributor/faq.html#know-if-a-release-note-is-needed-for-my-change - Things to do after releasing ============================ diff --git a/doc/source/contributor/states.rst b/doc/source/contributor/states.rst index 185bf2fc83..fa9cae4db5 100644 --- a/doc/source/contributor/states.rst +++ b/doc/source/contributor/states.rst @@ -27,4 +27,4 @@ Internally, the conductor initiates the other transitions (depicted in gray). For more information about the states, see the specification located at `ironic-state-machine`_. -.. _ironic-state-machine: http://specs.openstack.org/openstack/ironic-specs/specs/kilo-implemented/new-ironic-state-machine.html +.. _ironic-state-machine: https://specs.openstack.org/openstack/ironic-specs/specs/kilo-implemented/new-ironic-state-machine.html diff --git a/doc/source/contributor/webapi.rst b/doc/source/contributor/webapi.rst index 7d72dea6d1..7ebbf319b9 100644 --- a/doc/source/contributor/webapi.rst +++ b/doc/source/contributor/webapi.rst @@ -47,7 +47,7 @@ version of API that they have been tested against. microversion, which always requests the newest supported API version from the server. -.. _Nova versioning documentation: http://docs.openstack.org/developer/nova/api_microversion_dev.html#when-do-i-need-a-new-microversion +.. _Nova versioning documentation: https://docs.openstack.org/nova/latest/contributor/microversions.html#when-do-i-need-a-new-microversion REST API Versions History ------------------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index 4214b78838..e6a42e2e75 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -20,7 +20,7 @@ This documentation is continually updated and may not represent the state of the project at any specific prior release. To access documentation for a previous release of ironic, append the OpenStack release name to the URL; for example, the ``ocata`` release is available at -http://docs.openstack.org/ironic/ocata/. +https://docs.openstack.org/ironic/ocata/. User Guide ========== @@ -69,7 +69,7 @@ guide as well as more detailed reference documentation. :maxdepth: 1 API Concept Guide - API Reference (latest) + API Reference (latest) API Version History Command References