diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 4438f88b0e..0301ae34de 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -16,19 +16,19 @@ documentation to testing to deployment scripts. If you would like to contribute to the documents, please see the `OpenStack Documentation Contributor Guide -`_. +`_. If you would like to contribute to the development of OpenStack, you must follow the steps in this page: - http://docs.openstack.org/infra/manual/developers.html + https://docs.openstack.org/infra/manual/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: - http://docs.openstack.org/infra/manual/developers.html#development-workflow + https://docs.openstack.org/infra/manual/developers.html#development-workflow Pull requests submitted through GitHub will be ignored. diff --git a/README.rst b/README.rst index c1bc679a01..0435d45026 100644 --- a/README.rst +++ b/README.rst @@ -2,8 +2,8 @@ Team and repository tags ======================== -.. image:: http://governance.openstack.org/badges/openstack-manuals.svg - :target: http://governance.openstack.org/reference/tags/index.html +.. image:: https://governance.openstack.org/badges/openstack-manuals.svg + :target: https://governance.openstack.org/reference/tags/index.html .. Change things from this point on @@ -13,7 +13,7 @@ OpenStack Manuals This repository contains documentation for the OpenStack project. For more details, see the `OpenStack Documentation Contributor -Guide `_. +Guide `_. It includes these manuals: @@ -82,7 +82,7 @@ Generated files Some documentation files are generated using tools. These files include a ``do not edit`` header and should not be modified by hand. Please see `Generated files -`_. +`_. Bugs @@ -96,5 +96,5 @@ Bugs should be filed on Launchpad, not GitHub: Installing ========== -Refer to http://docs.openstack.org to see where these documents are published -and to learn more about the OpenStack project. +Refer to https://docs.openstack.org to see where these documents are +published and to learn more about the OpenStack project. diff --git a/bindep.txt b/bindep.txt index 259a7e4880..e521bd189c 100644 --- a/bindep.txt +++ b/bindep.txt @@ -1,5 +1,5 @@ # This is a cross-platform list tracking distribution packages needed by tests; -# see http://docs.openstack.org/infra/bindep/ for additional information. +# see https://docs.openstack.org/infra/bindep/ for additional information. fonts-nanum [platform:dpkg] fonts-takao [platform:dpkg] diff --git a/doc/arch-design/source/massively-scalable-operational-considerations.rst b/doc/arch-design/source/massively-scalable-operational-considerations.rst index ce30f44b97..16e2eac788 100644 --- a/doc/arch-design/source/massively-scalable-operational-considerations.rst +++ b/doc/arch-design/source/massively-scalable-operational-considerations.rst @@ -82,4 +82,4 @@ members to OpenStack conferences, meetup events, and encouraging active participation in the mailing lists and committees is a very important way to maintain skills and forge relationships in the community. For a list of OpenStack training providers in the marketplace, see the `Openstack Marketplace -`_. +`_. diff --git a/doc/arch-design/source/references.rst b/doc/arch-design/source/references.rst index f36642c010..f12f826a78 100644 --- a/doc/arch-design/source/references.rst +++ b/doc/arch-design/source/references.rst @@ -70,7 +70,7 @@ and installing OpenStack. OpenStack deployments. `OpenStack Training Marketplace -`_ +`_ : The OpenStack Market for training and Vendors providing training on OpenStack. diff --git a/doc/common/get-started-with-openstack.rst b/doc/common/get-started-with-openstack.rst index f39c03868d..e47502750e 100644 --- a/doc/common/get-started-with-openstack.rst +++ b/doc/common/get-started-with-openstack.rst @@ -23,23 +23,23 @@ OpenStack architecture: * - Service - Project name - Description - * - `Dashboard `__ + * - `Dashboard `__ - `Horizon `__ - Provides a web-based self-service portal to interact with underlying OpenStack services, such as launching an instance, assigning IP addresses and configuring access controls. - * - `Compute `__ + * - `Compute `__ - `Nova `__ - Manages the lifecycle of compute instances in an OpenStack environment. Responsibilities include spawning, scheduling and decommissioning of virtual machines on demand. - * - `Networking `__ + * - `Networking `__ - `Neutron `__ - Enables Network-Connectivity-as-a-Service for other OpenStack services, such as OpenStack Compute. Provides an API for users to define networks and the attachments into them. Has a pluggable architecture that supports many popular networking vendors and technologies. - * - `Object Storage `__ + * - `Object Storage `__ - `Swift `__ - Stores and retrieves arbitrary unstructured data objects via a RESTful, HTTP based API. It is highly fault tolerant with its data replication @@ -47,35 +47,35 @@ OpenStack architecture: with mountable directories. In this case, it writes objects and files to multiple drives, ensuring the data is replicated across a server cluster. - * - `Block Storage `__ + * - `Block Storage `__ - `Cinder `__ - Provides persistent block storage to running instances. Its pluggable driver architecture facilitates the creation and management of block storage devices. - * - `Identity service `__ + * - `Identity service `__ - `Keystone `__ - Provides an authentication and authorization service for other OpenStack services. Provides a catalog of endpoints for all OpenStack services. - * - `Image service `__ + * - `Image service `__ - `Glance `__ - Stores and retrieves virtual machine disk images. OpenStack Compute makes use of this during instance provisioning. - * - `Telemetry `__ + * - `Telemetry `__ - `Ceilometer `__ - Monitors and meters the OpenStack cloud for billing, benchmarking, scalability, and statistical purposes. - * - `Orchestration `__ + * - `Orchestration `__ - `Heat `__ - Orchestrates multiple composite cloud applications by using either the native HOT template format or the AWS CloudFormation template format, through both an OpenStack-native REST API and a CloudFormation-compatible Query API. - * - `Database service `__ + * - `Database service `__ - `Trove `__ - Provides scalable and reliable Cloud Database-as-a-Service functionality for both relational and non-relational database engines. - * - `Data processing service `__ + * - `Data processing service `__ - `Sahara `__ - Provides capabilities to provision and scale Hadoop clusters in OpenStack by specifying parameters like Hadoop version, cluster topology and nodes diff --git a/doc/config-reference/source/block-storage/nested-quota.rst b/doc/config-reference/source/block-storage/nested-quota.rst index a8867f0dd8..9fcdabdaa4 100644 --- a/doc/config-reference/source/block-storage/nested-quota.rst +++ b/doc/config-reference/source/block-storage/nested-quota.rst @@ -159,7 +159,7 @@ project. is true even when project B has not created any volumes. See `cinder nested quota spec -`_ +`_ and `hierarchical multi-tenancy spec `_ for details. diff --git a/doc/contributor-guide/source/api-guides.rst b/doc/contributor-guide/source/api-guides.rst index b9c19d5255..927ab3eddc 100644 --- a/doc/contributor-guide/source/api-guides.rst +++ b/doc/contributor-guide/source/api-guides.rst @@ -152,7 +152,7 @@ documentation, patch the ``reference/projects.yaml`` file in the .. _`wadl2rst`: http://github.com/annegentle/wadl2rst .. _`Compute API Guide`: https://developer.openstack.org/api-guide/compute .. _`example patch`: https://review.openstack.org/#/c/233446/ -.. _`API documentation guidelines`: http://specs.openstack.org/openstack/api-wg/guidelines/api-docs.html +.. _`API documentation guidelines`: https://specs.openstack.org/openstack/api-wg/guidelines/api-docs.html .. _`nova example`: https://github.com/openstack/nova/blob/master/api-ref/source/conf.py .. _`openstack/api-site repository`: http://git.openstack.org/cgit/openstack/api-site/tree/api-quick-start/source/index.rst .. _`openstack/governance repository`: http://git.openstack.org/cgit/openstack/governance/tree/reference/projects.yaml diff --git a/doc/contributor-guide/source/blueprints-and-specs.rst b/doc/contributor-guide/source/blueprints-and-specs.rst index 6fcaed50b5..ed69241992 100644 --- a/doc/contributor-guide/source/blueprints-and-specs.rst +++ b/doc/contributor-guide/source/blueprints-and-specs.rst @@ -10,7 +10,7 @@ Blueprints and specifications The Documentation team uses specifications in the `docs-specs repository `_ to maintain large changes. Approved specifications are published at `Documentation Program -Specifications `_. +Specifications `_. For tracking purposes, a blueprint is created for each specification. It is also good practice to contact the speciality team for the book you want to change to discuss your changes before starting work. diff --git a/doc/contributor-guide/source/doc-bugs.rst b/doc/contributor-guide/source/doc-bugs.rst index 31a5e3ea76..6e2bf48787 100644 --- a/doc/contributor-guide/source/doc-bugs.rst +++ b/doc/contributor-guide/source/doc-bugs.rst @@ -154,7 +154,7 @@ Bugs to update tables for the configuration references use the tag For updates of specific sections or adding of new drivers, follow the specification `Proprietary driver docs in openstack-manuals -`_ +`_ and assign the bug to the contact person that is mentioned on the `Vendor driver page `_. If diff --git a/doc/contributor-guide/source/quickstart/first-timers.rst b/doc/contributor-guide/source/quickstart/first-timers.rst index a86881d3c2..163c50fb63 100644 --- a/doc/contributor-guide/source/quickstart/first-timers.rst +++ b/doc/contributor-guide/source/quickstart/first-timers.rst @@ -154,7 +154,7 @@ Committing a change #. Follow the URL returned from ``git-review`` to check your commit:: - http://review.openstack.org/ + https://review.openstack.org/ Celebrate and wait for reviews! @@ -264,7 +264,7 @@ git and git review Permission denied (publickey). Double check the :guilabel:`Settings` page at - http://review.openstack.org to make sure your public key on the computer + https://review.openstack.org to make sure your public key on the computer or virtual server has been copied to SSH public keys on https://review.openstack.org/#/settings/ssh-keys. If you have not adjusted your ``.ssh`` configuration, your system may not be connecting using @@ -339,7 +339,7 @@ instead: .. _`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#installing-git-review .. _`OpenStack Documentation Bug Team`: https://launchpad.net/~openstack-doc-bugs -.. _`OpenStack Foundation`: http://www.openstack.org/join +.. _`OpenStack Foundation`: https://www.openstack.org/join .. _`Development Workflow`: https://docs.openstack.org/infra/manual/developers.html#development-workflow .. _`git`: http://msysgit.github.io .. _`curl`: http://curl.haxx.se/ diff --git a/doc/networking-guide/source/config-qos.rst b/doc/networking-guide/source/config-qos.rst index f3e123ed89..18f54c3d94 100644 --- a/doc/networking-guide/source/config-qos.rst +++ b/doc/networking-guide/source/config-qos.rst @@ -23,7 +23,7 @@ ml2 extension driver. Details about the DB models, API extension, and use cases are out of the scope of this guide but can be found in the -`Neutron QoS specification `_. +`Neutron QoS specification `_. Supported QoS rule types diff --git a/doc/ops-guide/source/app-roadmaps.rst b/doc/ops-guide/source/app-roadmaps.rst index dc8106a9b0..48d28e574f 100644 --- a/doc/ops-guide/source/app-roadmaps.rst +++ b/doc/ops-guide/source/app-roadmaps.rst @@ -180,7 +180,7 @@ Release notes are maintained on the OpenStack wiki, and also shown here: Here are some other resources: - `A breakdown of current features under development, with their target - milestone `_ + milestone `_ - `A list of all features, including those not yet under development `_ @@ -215,7 +215,7 @@ to work with blueprints the perspective of Victoria Martínez, a developer intern. The roadmap for the next release as it is developed can be seen at -`Releases `_. +`Releases `_. To determine the potential features going in to future releases, or to look at features implemented previously, take a look at the existing @@ -226,8 +226,9 @@ Blueprints `_, and release notes. Aside from the direct-to-blueprint pathway, there is another very -well-regarded mechanism to influence the development roadmap: the user -survey. Found at `OpenStack User Survey `_, +well-regarded mechanism to influence the development roadmap: +the user survey. Found at `OpenStack User Survey +`_, it allows you to provide details of your deployments and needs, anonymously by default. Each cycle, the user committee analyzes the results and produces a report, including providing specific information to the technical diff --git a/doc/ops-guide/source/arch-example-thoughts.rst b/doc/ops-guide/source/arch-example-thoughts.rst index 1c8a9f9da2..a4097b6a80 100644 --- a/doc/ops-guide/source/arch-example-thoughts.rst +++ b/doc/ops-guide/source/arch-example-thoughts.rst @@ -9,4 +9,4 @@ exploration. If you're looking for additional ideas, check out `Installation Tutorials and Guides `_, or the `OpenStack User Stories -page `_. +page `_. diff --git a/doc/ops-guide/source/ops-upgrades.rst b/doc/ops-guide/source/ops-upgrades.rst index e1f66f95b0..e2363c771e 100644 --- a/doc/ops-guide/source/ops-upgrades.rst +++ b/doc/ops-guide/source/ops-upgrades.rst @@ -14,7 +14,7 @@ Upgrade planning ---------------- - Thoroughly review the `release - notes `_ to learn + notes `_ to learn about new, updated, and deprecated features. Find incompatibilities between versions. diff --git a/doc/ops-guide/source/preface.rst b/doc/ops-guide/source/preface.rst index d816cdcf4a..9d30bb52ac 100644 --- a/doc/ops-guide/source/preface.rst +++ b/doc/ops-guide/source/preface.rst @@ -77,7 +77,7 @@ experience, such as Mirantis or Metacloud. If your preference is to build your own OpenStack expertise internally, a good way to kick-start that might be to attend or arrange a training session. The OpenStack Foundation has a `Training -Marketplace `_ where you +Marketplace `_ where you can look for nearby events. Also, the OpenStack community is `working to produce `_ open source training materials.