[contrib-guide] Updating url to doc-contrib-guide

Based off conversation at the PTG, we agreed it would be
beneficial to ensure the contrib-guide is clearly marked
as the doc contrib guide outside of the title.

This change includes a redirect.

Change-Id: I5abf915f0b94a482afa961e6b86364c26aae5d79
This commit is contained in:
Alexandra Settle 2017-09-13 13:56:23 -06:00
parent b608b826c9
commit 85107272be
154 changed files with 181 additions and 174 deletions

View File

@ -16,7 +16,7 @@ documentation to testing to deployment scripts.
If you would like to contribute to the documents, please see the If you would like to contribute to the documents, please see the
`OpenStack Documentation Contributor Guide `OpenStack Documentation Contributor Guide
<https://docs.openstack.org/contributor-guide/>`_. <https://docs.openstack.org/doc-contrib-guide/>`_.
If you would like to contribute to the development of OpenStack, you must If you would like to contribute to the development of OpenStack, you must
follow the steps in this page: follow the steps in this page:

View File

@ -13,7 +13,7 @@ OpenStack Manuals
This repository contains documentation for the OpenStack project. This repository contains documentation for the OpenStack project.
For more details, see the `OpenStack Documentation Contributor For more details, see the `OpenStack Documentation Contributor
Guide <https://docs.openstack.org/contributor-guide/>`_. Guide <https://docs.openstack.org/doc-contrib-guide/>`_.
It includes these manuals: It includes these manuals:
@ -97,7 +97,7 @@ Generated files
Some documentation files are generated using tools. These files include Some documentation files are generated using tools. These files include
a ``do not edit`` header and should not be modified by hand. a ``do not edit`` header and should not be modified by hand.
Please see `Generated files Please see `Generated files
<https://docs.openstack.org/contributor-guide/doc-tools.html>`_. <https://docs.openstack.org/doc-contrib-guide/doc-tools.html>`_.
Bugs Bugs

View File

@ -29,7 +29,7 @@ declare -A SPECIAL_BOOKS=(
["install-guide"]="RST" ["install-guide"]="RST"
# Do not translate # Do not translate
["arch-design"]="skip" ["arch-design"]="skip"
["contributor-guide"]="skip" ["doc-contrib-guide"]="skip"
["releasenotes"]="skip" ["releasenotes"]="skip"
["ha-guide-draft"]="skip" ["ha-guide-draft"]="skip"
) )

View File

@ -62,7 +62,7 @@ for the OpenStack APIs:
The following guide provides how to contribute to OpenStack documentation: The following guide provides how to contribute to OpenStack documentation:
* `Documentation Contributor Guide <https://docs.openstack.org/contributor-guide/>`_ * `Documentation Contributor Guide <https://docs.openstack.org/doc-contrib-guide/>`_
ask.openstack.org ask.openstack.org
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
@ -102,7 +102,7 @@ of relevant material. More is being added all the time, so be sure to
check back often. You can find the search box in the upper-right corner check back often. You can find the search box in the upper-right corner
of any OpenStack wiki page. of any OpenStack wiki page.
The Launchpad Bugs area The Launchpad bugs area
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
The OpenStack community values your set up and testing efforts and wants The OpenStack community values your set up and testing efforts and wants

View File

@ -264,8 +264,8 @@ and the `built documentation <https://docs.openstack.org/horizon/>`_.
- Target location - Target location
* - Documentation Contributor Guide * - Documentation Contributor Guide
- https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/contributor-guide - https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/doc-contrib-guide
- https://docs.openstack.org/contributor-guide/ - https://docs.openstack.org/doc-contrib-guide/
* - Python Developer Documentation * - Python Developer Documentation
- https://git.openstack.org/cgit/openstack/<project>/tree/master/doc/source/, - https://git.openstack.org/cgit/openstack/<project>/tree/master/doc/source/,

View File

@ -55,8 +55,8 @@ master_doc = 'index'
# General information about the project. # General information about the project.
repository_name = "openstack/openstack-manuals" repository_name = "openstack/openstack-manuals"
bug_project = 'openstack-manuals' bug_project = 'openstack-manuals'
project = u'Contributor Guide' project = u'Documentation Contributor Guide'
bug_tag = u'contributor-guide' bug_tag = u'doc-contrib-guide'
copyright = u'2015-2017, OpenStack contributors' copyright = u'2015-2017, OpenStack contributors'
@ -200,7 +200,7 @@ html_show_sourcelink = False
# html_file_suffix = None # html_file_suffix = None
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'contributor-guide' htmlhelp_basename = 'doc-contrib-guide'
# If true, publish source files # If true, publish source files
html_copy_source = False html_copy_source = False

View File

@ -26,8 +26,8 @@ The value of ``new-branch`` is any name you want to give to your branch.
To work on a file, use a text editor and open the ``.rst`` file from the same To work on a file, use a text editor and open the ``.rst`` file from the same
navigational path as the path shown in the HTML URL. For example, navigational path as the path shown in the HTML URL. For example,
https://docs.openstack.org/contributor-guide/docs-builds.html, is found in the https://docs.openstack.org/doc-contrib-guide/docs-builds.html, is found in the
folder: ``openstack-manuals/doc/contributor-guide/docs-builds.rst``. folder: ``openstack-manuals/doc/doc-contrib-guide/docs-builds.rst``.
Refer to :doc:`Writing documentation <writing-docs>` for details on how to Refer to :doc:`Writing documentation <writing-docs>` for details on how to
create content and contribute to the documentation. create content and contribute to the documentation.

View File

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

View File

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 38 KiB

View File

Before

Width:  |  Height:  |  Size: 9.9 KiB

After

Width:  |  Height:  |  Size: 9.9 KiB

View File

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 27 KiB

View File

Before

Width:  |  Height:  |  Size: 8.6 KiB

After

Width:  |  Height:  |  Size: 8.6 KiB

View File

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 31 KiB

View File

Before

Width:  |  Height:  |  Size: 7.9 KiB

After

Width:  |  Height:  |  Size: 7.9 KiB

View File

@ -211,7 +211,7 @@ Each title should include a clear description of the pages subject.
Also, ensure that you follow the documentation guidelines for titles. Also, ensure that you follow the documentation guidelines for titles.
For more information, see `Titles For more information, see `Titles
<https://docs.openstack.org/contributor-guide/rst-conv/titles.html>`_. <https://docs.openstack.org/doc-contrib-guide/rst-conv/titles.html>`_.
.. _be_clear_and_concise: .. _be_clear_and_concise:

Some files were not shown because too many files have changed in this diff Show More