[contributor] use https instead of http for docs.o.o
Change-Id: Ife7a36926facd08ffda77810d83083b5f19f4783
This commit is contained in:
parent
2c7324511a
commit
41476b346a
doc/contributor-guide
setup.cfg
source
blueprints-and-specs.rst
doc-tools
docs-builds.rstdocs-review.rstproject-deploy-guide.rstproject-install-guide.rstquickstart
release
rst-conv
ux-ui-guidelines
writing-style
@ -3,7 +3,7 @@ name = openstackdocumentationcontributorguide
|
||||
summary = OpenStack Documentation Contributor Guide
|
||||
author = OpenStack
|
||||
author-email = openstack-docs@lists.openstack.org
|
||||
home-page = http://docs.openstack.org/
|
||||
home-page = https://docs.openstack.org/
|
||||
classifier =
|
||||
Environment :: OpenStack
|
||||
Intended Audience :: Information Technology
|
||||
|
@ -44,7 +44,7 @@ Release-specific documentation
|
||||
|
||||
The Installation Tutorials and Guides, Configuration Reference, and Networking
|
||||
Guide are released at release time, with draft material published to
|
||||
http://docs.openstack.org/draft/draft-index.html.
|
||||
https://docs.openstack.org/draft/draft-index.html.
|
||||
The rest of the guides are continuously released.
|
||||
|
||||
To patch for the release-specific documentation, you should generally patch to
|
||||
@ -78,33 +78,33 @@ process for multiple distributions based on the following packaging systems:
|
||||
|
||||
* - Installation Tutorial for openSUSE and SUSE Linux Enterprise Server
|
||||
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide
|
||||
- http://docs.openstack.org/newton/install-guide-obs/
|
||||
- https://docs.openstack.org/newton/install-guide-obs/
|
||||
|
||||
* - Installation Tutorial for Red Hat Enterprise Linux and CentOS
|
||||
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide
|
||||
- http://docs.openstack.org/newton/install-guide-rdo/
|
||||
- https://docs.openstack.org/newton/install-guide-rdo/
|
||||
|
||||
* - Installation Tutorial for Ubuntu 16.04 (LTS)
|
||||
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide
|
||||
- http://docs.openstack.org/newton/install-guide-ubuntu/
|
||||
- https://docs.openstack.org/newton/install-guide-ubuntu/
|
||||
|
||||
* - Installation Tutorial For Debian With Debconf
|
||||
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide
|
||||
- http://docs.openstack.org/newton/install-guide-debconf/
|
||||
- https://docs.openstack.org/newton/install-guide-debconf/
|
||||
|
||||
* - Installation Tutorial For Debian
|
||||
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide
|
||||
- http://docs.openstack.org/newton/install-guide-debian/
|
||||
- https://docs.openstack.org/newton/install-guide-debian/
|
||||
|
||||
Guides for deployers and administrators
|
||||
---------------------------------------
|
||||
|
||||
* `OpenStack Configuration Reference
|
||||
<http://docs.openstack.org/newton/config-reference/>`_:
|
||||
<https://docs.openstack.org/newton/config-reference/>`_:
|
||||
Contains a reference listing of all configuration options for OpenStack
|
||||
services by release version.
|
||||
* `OpenStack Networking Guide
|
||||
<http://docs.openstack.org/newton/networking-guide/>`_:
|
||||
<https://docs.openstack.org/newton/networking-guide/>`_:
|
||||
This guide targets OpenStack administrators seeking to deploy and manage
|
||||
OpenStack Networking (neutron).
|
||||
|
||||
@ -117,11 +117,11 @@ Guides for deployers and administrators
|
||||
|
||||
* - Configuration Reference
|
||||
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/config-reference
|
||||
- http://docs.openstack.org/newton/config-reference/
|
||||
- https://docs.openstack.org/newton/config-reference/
|
||||
|
||||
* - OpenStack Networking Guide
|
||||
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/networking-guide
|
||||
- http://docs.openstack.org/newton/networking-guide/
|
||||
- https://docs.openstack.org/newton/networking-guide/
|
||||
|
||||
Continuously released documentation
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@ -139,20 +139,20 @@ Guides for deployers and administrators
|
||||
---------------------------------------
|
||||
|
||||
* `OpenStack Architecture Design Guide
|
||||
<http://docs.openstack.org/arch-design/>`_:
|
||||
<https://docs.openstack.org/arch-design/>`_:
|
||||
Contains information on how to plan, design and architect
|
||||
an OpenStack cloud.
|
||||
* `OpenStack Administrator Guide <http://docs.openstack.org/admin-guide/>`_:
|
||||
* `OpenStack Administrator Guide <https://docs.openstack.org/admin-guide/>`_:
|
||||
Contains how-to information for managing an OpenStack cloud as needed for
|
||||
your use cases, such as storage, computing, or software-defined-networking.
|
||||
* `OpenStack High Availability Guide <http://docs.openstack.org/ha-guide/>`_:
|
||||
* `OpenStack High Availability Guide <https://docs.openstack.org/ha-guide/>`_:
|
||||
Describes potential strategies for making your OpenStack services and
|
||||
related controllers and data stores highly available.
|
||||
* `OpenStack Security Guide <http://docs.openstack.org/sec/>`_:
|
||||
* `OpenStack Security Guide <https://docs.openstack.org/sec/>`_:
|
||||
Provide best practices and conceptual
|
||||
information about securing an OpenStack cloud.
|
||||
* `OpenStack Virtual Machine Image Guide
|
||||
<http://docs.openstack.org/image-guide/>`_:
|
||||
<https://docs.openstack.org/image-guide/>`_:
|
||||
Shows you how to obtain, create, and modify virtual machine images that
|
||||
are compatible with OpenStack.
|
||||
|
||||
@ -165,28 +165,28 @@ Guides for deployers and administrators
|
||||
|
||||
* - OpenStack Architecture Design Guide
|
||||
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/arch-design
|
||||
- http://docs.openstack.org/arch-design/
|
||||
- https://docs.openstack.org/arch-design/
|
||||
|
||||
* - OpenStack Administrator Guide
|
||||
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/admin-guide
|
||||
- http://docs.openstack.org/admin-guide/
|
||||
- https://docs.openstack.org/admin-guide/
|
||||
|
||||
* - OpenStack High Availability Guide
|
||||
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/ha-guide
|
||||
- http://docs.openstack.org/ha-guide/
|
||||
- https://docs.openstack.org/ha-guide/
|
||||
|
||||
* - OpenStack Security Guide
|
||||
- http://git.openstack.org/cgit/openstack/security-doc/tree/security-guide
|
||||
- http://docs.openstack.org/security-guide/
|
||||
- https://docs.openstack.org/security-guide/
|
||||
|
||||
* - OpenStack Virtual Machine Image Guide
|
||||
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/image-guide
|
||||
- http://docs.openstack.org/image-guide/
|
||||
- https://docs.openstack.org/image-guide/
|
||||
|
||||
Guides for end users
|
||||
--------------------
|
||||
|
||||
* `OpenStack End User Guide <http://docs.openstack.org/user-guide/>`_:
|
||||
* `OpenStack End User Guide <https://docs.openstack.org/user-guide/>`_:
|
||||
Shows OpenStack end users how to create and manage resources in an
|
||||
OpenStack cloud with the OpenStack dashboard and OpenStack client commands.
|
||||
* `OpenStack API Guide
|
||||
@ -194,7 +194,7 @@ Guides for end users
|
||||
A brief overview of how to send REST API requests to endpoints for
|
||||
OpenStack services.
|
||||
* `OpenStack Command-Line Interface Reference
|
||||
<http://docs.openstack.org/cli-reference/>`_:
|
||||
<https://docs.openstack.org/cli-reference/>`_:
|
||||
Automatically generates help text for CLI commands and subcommands.
|
||||
|
||||
.. list-table::
|
||||
@ -206,7 +206,7 @@ Guides for end users
|
||||
|
||||
* - OpenStack End User Guide
|
||||
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/user-guide
|
||||
- http://docs.openstack.org/user-guide/
|
||||
- https://docs.openstack.org/user-guide/
|
||||
|
||||
* - OpenStack API Guide
|
||||
- http://git.openstack.org/cgit/openstack/api-site/tree/api-quick-start
|
||||
@ -214,7 +214,7 @@ Guides for end users
|
||||
|
||||
* - OpenStack Command-Line Interface Reference
|
||||
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/cli-reference
|
||||
- http://docs.openstack.org/cli-reference/
|
||||
- https://docs.openstack.org/cli-reference/
|
||||
|
||||
API documentation
|
||||
-----------------
|
||||
@ -226,7 +226,7 @@ API documentation
|
||||
Within project's specification repos, some have opted
|
||||
to document API specifications, such as Identity.
|
||||
* `Object Storage API v1
|
||||
<http://docs.openstack.org/developer/swift/#object-storage-v1-rest-api-documentation>`_
|
||||
<https://docs.openstack.org/developer/swift/#object-storage-v1-rest-api-documentation>`_
|
||||
|
||||
We are migrating away from WADL in 2016. Refer to :ref:`api-docs` for details.
|
||||
Once the migration is complete, the API reference pages will be stored in the
|
||||
@ -237,21 +237,21 @@ Project-specific guides
|
||||
|
||||
Each project maintains its own developer guide.
|
||||
They are published from each project repository.
|
||||
See http://docs.openstack.org/developer/openstack-projects.html
|
||||
and http://docs.openstack.org/developer/language-bindings.html.
|
||||
See https://docs.openstack.org/developer/openstack-projects.html
|
||||
and https://docs.openstack.org/developer/language-bindings.html.
|
||||
|
||||
Contributor guides
|
||||
------------------
|
||||
|
||||
Generally, the http://docs.openstack.org/developer/ documentation is meant
|
||||
Generally, the https://docs.openstack.org/developer/ documentation is meant
|
||||
for contributors to OpenStack projects. Each project's repo has a
|
||||
``doc/source`` directory where RST source files are stored. They are built
|
||||
automatically with Sphinx when the patch is merged. For example, see
|
||||
http://git.openstack.org/cgit/openstack/horizon/tree/doc/source for the
|
||||
horizon contributor documentation source and http://docs.openstack.org/developer/horizon/
|
||||
horizon contributor documentation source and https://docs.openstack.org/developer/horizon/
|
||||
for the built documentation.
|
||||
|
||||
* `Infrastructure User Manual <http://docs.openstack.org/infra/manual>`_:
|
||||
* `Infrastructure User Manual <https://docs.openstack.org/infra/manual>`_:
|
||||
Reference documentation for tools and processes used for all
|
||||
contributors to OpenStack projects. It includes instructions on how
|
||||
to create all the necessary accounts, setup development environment,
|
||||
@ -268,25 +268,25 @@ for the built documentation.
|
||||
|
||||
* - Documentation Contributor Guide
|
||||
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/contributor-guide
|
||||
- http://docs.openstack.org/contributor-guide/
|
||||
- https://docs.openstack.org/contributor-guide/
|
||||
|
||||
* - Python Developer Documentation
|
||||
- http://git.openstack.org/cgit/openstack/<project>/tree/master/doc/source/,
|
||||
such as http://git.openstack.org/cgit/openstack/nova/tree/doc/source
|
||||
- http://docs.openstack.org/developer/openstack-projects.html
|
||||
- https://docs.openstack.org/developer/openstack-projects.html
|
||||
|
||||
* - Language Bindings and Python Clients
|
||||
- http://git.openstack.org/cgit/openstack/python-<project>client/tree/master/doc/source/,
|
||||
such as http://git.openstack.org/cgit/openstack/python-novaclient/tree/doc/source
|
||||
- http://docs.openstack.org/developer/language-bindings.html
|
||||
- https://docs.openstack.org/developer/language-bindings.html
|
||||
|
||||
* - OpenStack Project Infrastructure
|
||||
- http://git.openstack.org/cgit/openstack-infra/system-config/tree/doc/source
|
||||
- http://docs.openstack.org/infra/system-config/
|
||||
- https://docs.openstack.org/infra/system-config/
|
||||
|
||||
* - Tempest Testing Project
|
||||
- http://git.openstack.org/cgit/openstack/tempest/tree/doc/source
|
||||
- http://docs.openstack.org/developer/tempest/
|
||||
- https://docs.openstack.org/developer/tempest/
|
||||
|
||||
Guides for contributors
|
||||
-----------------------
|
||||
|
@ -12,9 +12,9 @@ To contribute to the development of ``openstack-doc-tools``, proceed with
|
||||
the following steps:
|
||||
|
||||
#. Complete the procedures described
|
||||
in the `Developers Guide <http://docs.openstack.org/infra/manual/developers.html>`_.
|
||||
in the `Developers Guide <https://docs.openstack.org/infra/manual/developers.html>`_.
|
||||
|
||||
#. Follow `OpenStack Style Commandments <http://docs.openstack.org/developer/hacking/>`_
|
||||
#. Follow `OpenStack Style Commandments <https://docs.openstack.org/developer/hacking/>`_
|
||||
while developing improvements for the tool.
|
||||
|
||||
#. Run tests before you submit your change request.
|
||||
@ -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 <http://docs.openstack.org/infra/manual/developers.html#development-workflow>`_.
|
||||
in the `gerrit workflow <https://docs.openstack.org/infra/manual/developers.html#development-workflow>`_.
|
||||
|
||||
.. warning::
|
||||
|
||||
|
@ -11,7 +11,7 @@ openstack-doc-tools repository
|
||||
|
||||
autogenerate_config_docs
|
||||
Generates configuration references published at
|
||||
http://docs.openstack.org/newton/config-reference/.
|
||||
https://docs.openstack.org/newton/config-reference/.
|
||||
|
||||
build_environment directory (deprecated)
|
||||
A Vagrant environment for working with the guides.
|
||||
@ -34,7 +34,7 @@ openstack-autohelp
|
||||
|
||||
openstack-auto-commands
|
||||
Generates the command-line interface reference published at
|
||||
http://docs.openstack.org/cli-reference/. A helper script to use this
|
||||
https://docs.openstack.org/cli-reference/. A helper script to use this
|
||||
tool is available at ``bin/doc-tools-update-cli-reference``.
|
||||
|
||||
openstack-jsoncheck
|
||||
@ -49,7 +49,7 @@ Several scripts currently reside in the `openstack-manuals
|
||||
beneficial to consolidate these into the ``openstack-doc-tools`` repository.
|
||||
|
||||
www-generator.py
|
||||
Generates static, template-based HTML files for http://docs.openstack.org/.
|
||||
Generates static, template-based HTML files for https://docs.openstack.org/.
|
||||
|
||||
sync-projects.sh
|
||||
Synchronizes the **Glossary**, common files, and some translations
|
||||
@ -57,7 +57,7 @@ sync-projects.sh
|
||||
|
||||
publishdocs.sh
|
||||
Publishdocs job uses this script to publish documentation to
|
||||
http://docs.openstack.org/.
|
||||
https://docs.openstack.org/.
|
||||
|
||||
|
||||
Notes
|
||||
|
@ -110,7 +110,7 @@ To get the ``.html`` output locally, switch to the directory containing a
|
||||
|
||||
The RST source is built into HTML using Sphinx, so that it is displayed on
|
||||
the *docs.openstack.org/<guide-name>*. For example:
|
||||
http://docs.openstack.org/user-guide/.
|
||||
https://docs.openstack.org/user-guide/.
|
||||
|
||||
Using Tox to check builds
|
||||
-------------------------
|
||||
|
@ -16,7 +16,7 @@ review, use the `Documentation Program Dashboard
|
||||
audience for the documentation. To see current proposed changes, make sure
|
||||
you register and log into https://review.openstack.org. For more details on
|
||||
the review process, see `Code Review
|
||||
<http://docs.openstack.org/infra/manual/developers.html#code-review>`_.
|
||||
<https://docs.openstack.org/infra/manual/developers.html#code-review>`_.
|
||||
|
||||
Repositories and core team
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@ -44,7 +44,7 @@ Reviewing a documentation patch
|
||||
Before you proceed with reviewing patches, make sure to read carefully
|
||||
the :doc:`Review Guidelines <docs-review-guidelines>` for documentation
|
||||
and `Code Review Guidelines
|
||||
<http://docs.openstack.org/infra/manual/developers.html#code-review>`_.
|
||||
<https://docs.openstack.org/infra/manual/developers.html#code-review>`_.
|
||||
Once done, follow the steps below to submit a patch review.
|
||||
|
||||
#. Go to the `Documentation Program Dashboard
|
||||
@ -70,12 +70,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
|
||||
<http://docs.openstack.org/infra/manual/core.html#work-in-progress>`_.
|
||||
<https://docs.openstack.org/infra/manual/core.html#work-in-progress>`_.
|
||||
|
||||
.. seealso::
|
||||
|
||||
`Peer Review
|
||||
<http://docs.openstack.org/infra/manual/developers.html#peer-review>`_
|
||||
<https://docs.openstack.org/infra/manual/developers.html#peer-review>`_
|
||||
|
||||
Achieving core reviewer status
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@ -124,7 +124,7 @@ unfavorable gets through, without discouraging contributions.
|
||||
|
||||
General instructions for being a core reviewer are located in the
|
||||
`Core Reviewer's Guide
|
||||
<http://docs.openstack.org/infra/manual/developers.html#code-review>`_.
|
||||
<https://docs.openstack.org/infra/manual/developers.html#code-review>`_.
|
||||
This section is for openstack-manuals core reviewers.
|
||||
|
||||
In almost all cases, patches can be merged with at least one +1 vote, and
|
||||
|
@ -6,7 +6,7 @@ As of the Newton release, a new method of publishing deployment guides has
|
||||
been implemented. This allows each deployment projects to create their own
|
||||
deployment guide, based on a standard template, in their own repository.
|
||||
These guides are then centrally published to
|
||||
`Deployment Guides <http://docs.openstack.org/project-deploy-guide/newton/>`_.
|
||||
`Deployment Guides <https://docs.openstack.org/project-deploy-guide/newton/>`_.
|
||||
|
||||
Setting up
|
||||
~~~~~~~~~~
|
||||
|
@ -6,7 +6,7 @@ For the Newton release, a new method of publishing installation tutorials
|
||||
and guides is being implemented. This will allow each big tent project to
|
||||
create their own installation guide, based on a standard template,
|
||||
in their own repository. These guides are then centrally published to
|
||||
`docs.openstack.org <http://docs.openstack.org>`_.
|
||||
`docs.openstack.org <https://docs.openstack.org>`_.
|
||||
|
||||
For updates on the progress of this project, see the `Install Guide wiki
|
||||
page <https://wiki.openstack.org/wiki/Documentation/InstallGuideWorkItems>`_.
|
||||
|
@ -294,7 +294,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 http
|
||||
endpoint instead of ssh <http://docs.openstack.org/infra/manual/developers.html#accessing-gerrit-over-https>`_
|
||||
endpoint instead of ssh <https://docs.openstack.org/infra/manual/developers.html#accessing-gerrit-over-https>`_
|
||||
as explained in the Infrastructure Manual.
|
||||
|
||||
Python
|
||||
@ -335,12 +335,12 @@ instead:
|
||||
|
||||
.. Links
|
||||
|
||||
.. _`Account Setup`: http://docs.openstack.org/infra/manual/developers.html#account-setup
|
||||
.. _`Sign the appropriate Individual Contributor License Agreement`: http://docs.openstack.org/infra/manual/developers.html#sign-the-appropriate-individual-contributor-license-agreement
|
||||
.. _`Installing git-review`: http://docs.openstack.org/infra/manual/developers.html#installing-git-review
|
||||
.. _`Account Setup`: https://docs.openstack.org/infra/manual/developers.html#account-setup
|
||||
.. _`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
|
||||
.. _`Development Workflow`: http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||
.. _`Development Workflow`: https://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||
.. _`git`: http://msysgit.github.io
|
||||
.. _`curl`: http://curl.haxx.se/
|
||||
.. _`tar`: http://gnuwin32.sourceforge.net/packages/gtar.htm
|
||||
@ -350,8 +350,8 @@ instead:
|
||||
.. _`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
|
||||
.. _`Starting Work on a New Project`: http://docs.openstack.org/infra/manual/developers.html#starting-work-on-a-new-project
|
||||
.. _`Starting a Change`: http://docs.openstack.org/infra/manual/developers.html#starting-a-change
|
||||
.. _`Committing a change`: http://docs.openstack.org/infra/manual/developers.html#committing-a-change
|
||||
.. _`Submitting a Change for Review`: http://docs.openstack.org/infra/manual/developers.html#submitting-a-change-for-review
|
||||
.. _`Updating a Change`: http://docs.openstack.org/infra/manual/developers.html#updating-a-change
|
||||
.. _`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
|
||||
|
@ -9,4 +9,4 @@ The ``openstackdocstheme``, ``openstack-doc-tools``, and
|
||||
The release is done by the OpenStack release team but needs to be
|
||||
triggered by the documentation team. For details, see `Release
|
||||
management
|
||||
<http://docs.openstack.org/project-team-guide/release-management.html#how-to-release>`__.
|
||||
<https://docs.openstack.org/project-team-guide/release-management.html#how-to-release>`__.
|
||||
|
@ -60,7 +60,7 @@ Speciality Team lead, listed at :doc:`../team-structure`., and ask them for
|
||||
the notes for the books they look after. The source repository for release
|
||||
notes is `openstack-manuals/releasenotes/source/RELEASENAME` and they are
|
||||
published to
|
||||
``http://docs.openstack.org/releasenotes/openstack-manuals/RELEASENAME.html``.
|
||||
``https://docs.openstack.org/releasenotes/openstack-manuals/RELEASENAME.html``.
|
||||
|
||||
Publish index page
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
@ -163,7 +163,7 @@ for release-specific documentation:
|
||||
as OpenStack Liberty has reached its official end-of-life.
|
||||
This guide will not get any updates from the OpenStack project anymore.
|
||||
See the `OpenStack Documentation page
|
||||
<http://docs.openstack.org/>`_ for current documentation.
|
||||
<https://docs.openstack.org/>`_ for current documentation.
|
||||
|
||||
For continuously released documentation, exclude the release from target.
|
||||
|
||||
@ -180,5 +180,5 @@ To:
|
||||
This guide documents OpenStack Newton and Mitaka releases.
|
||||
|
||||
However, we will keep the documentation on the
|
||||
`docs.openstack.org <http://docs.openstack.org/>`_
|
||||
`docs.openstack.org <https://docs.openstack.org/>`_
|
||||
page for a while so that the users can refer the guides if necessary.
|
||||
|
@ -56,14 +56,14 @@ To link to some external locations, format the RST source as follows:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
Here is a link to the User guide: http://docs.openstack.org/user-guide/.
|
||||
Here is a link to the User guide: https://docs.openstack.org/user-guide/.
|
||||
|
||||
Here is an external web link with a link title:
|
||||
`User guide <http://docs.openstack.org/user-guide/>`_.
|
||||
`User guide <https://docs.openstack.org/user-guide/>`_.
|
||||
|
||||
**Output**
|
||||
|
||||
Here is a link to the User guide: http://docs.openstack.org/user-guide/.
|
||||
Here is a link to the User guide: https://docs.openstack.org/user-guide/.
|
||||
|
||||
Here is an external web link with a link title:
|
||||
`User guide <http://docs.openstack.org/user-guide/>`_.
|
||||
`User guide <https://docs.openstack.org/user-guide/>`_.
|
||||
|
@ -94,7 +94,7 @@ The following patterns provide GUI frameworks to assist designers and engineers
|
||||
to create interfaces that are consistent across OpenStack products.
|
||||
|
||||
For example, the horizon project chooses to use ``bootstrap``.
|
||||
See `Styling in Horizon (SCSS) <http://docs.openstack.org/developer/horizon/topics/styling.html>`_
|
||||
See `Styling in Horizon (SCSS) <https://docs.openstack.org/developer/horizon/topics/styling.html>`_
|
||||
for more information.
|
||||
|
||||
Cancel buttons
|
||||
|
@ -211,7 +211,7 @@ Each title should include a clear description of the page’s subject.
|
||||
|
||||
Also, ensure that you follow the documentation guidelines for titles.
|
||||
For more information,
|
||||
see http://docs.openstack.org/contributor-guide/rst-conv/titles.html.
|
||||
see https://docs.openstack.org/contributor-guide/rst-conv/titles.html.
|
||||
|
||||
.. _be_clear_and_concise:
|
||||
|
||||
|
@ -4,7 +4,7 @@ Release names
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Use the names of the OpenStack releases as described on
|
||||
the `OpenStack Releases <http://docs.openstack.org/releases/>`_
|
||||
the `OpenStack Releases <https://docs.openstack.org/releases/>`_
|
||||
page
|
||||
|
||||
**Example:**
|
||||
|
@ -6,7 +6,7 @@ Word choice
|
||||
|
||||
This section offers conventions around general English usage and the terms that
|
||||
are not covered in the
|
||||
`glossary <http://docs.openstack.org/glossary/content/glossary.html>`_.
|
||||
`glossary <https://docs.openstack.org/glossary/content/glossary.html>`_.
|
||||
Additionally, use the `IBM
|
||||
Terminology <http://www-01.ibm.com/software/globalization/terminology/>`_ as
|
||||
a reference.
|
||||
|
Loading…
x
Reference in New Issue
Block a user