Merge "Update and optimize documentation links"
This commit is contained in:
commit
0d3ea781ca
@ -3,7 +3,7 @@ Zaqar style commandments
|
|||||||
========================
|
========================
|
||||||
|
|
||||||
- Step 1: Read the OpenStack Style Commandments
|
- Step 1: Read the OpenStack Style Commandments
|
||||||
https://docs.openstack.org/developer/hacking/
|
https://docs.openstack.org/hacking/latest/
|
||||||
- Step 2: Read on for Zaqar specific commandments
|
- Step 2: Read on for Zaqar specific commandments
|
||||||
|
|
||||||
General
|
General
|
||||||
|
@ -46,11 +46,11 @@ Contributors are encouraged to join IRC (``#openstack-zaqar`` channel on
|
|||||||
|
|
||||||
Information on how to run unit and functional tests is available at:
|
Information on how to run unit and functional tests is available at:
|
||||||
|
|
||||||
https://docs.openstack.org/zaqar/admin/running_tests.html
|
https://docs.openstack.org/zaqar/latest/contributor/running_tests.html
|
||||||
|
|
||||||
Information on how to run benchmarking tool is available at:
|
Information on how to run benchmarking tool is available at:
|
||||||
|
|
||||||
https://docs.openstack.org/zaqar/admin/running_benchmark.html
|
https://docs.openstack.org/zaqar/latest/admin/running_benchmark.html
|
||||||
|
|
||||||
Using Zaqar
|
Using Zaqar
|
||||||
-----------
|
-----------
|
||||||
@ -66,7 +66,7 @@ Using Zaqar in development environment:
|
|||||||
|
|
||||||
The instruction is available at:
|
The instruction is available at:
|
||||||
|
|
||||||
https://docs.openstack.org/zaqar/contributor/development.environment.html
|
https://docs.openstack.org/zaqar/latest/contributor/development.environment.html
|
||||||
|
|
||||||
This will allow you to run local Zaqar server with MongoDB as database.
|
This will allow you to run local Zaqar server with MongoDB as database.
|
||||||
|
|
||||||
|
@ -116,5 +116,5 @@ CORS rule::
|
|||||||
Access-Control-Allow-Credentials: true
|
Access-Control-Allow-Credentials: true
|
||||||
Connection: close
|
Connection: close
|
||||||
|
|
||||||
.. _Official Doc: https://docs.openstack.org/developer/oslo.middleware/cors.html
|
.. _Official Doc: https://docs.openstack.org/oslo.middleware/latest/reference/cors.html
|
||||||
.. _OpenStack Spec: http://specs.openstack.org/openstack/openstack-specs/specs/cors-support.html
|
.. _OpenStack Spec: https://specs.openstack.org/openstack/openstack-specs/specs/cors-support.html
|
||||||
|
@ -122,4 +122,4 @@ Then you can open the file "list_test" to get the result.
|
|||||||
.. note:: If you used MQ for data transfer, the "--connection-string" here
|
.. note:: If you used MQ for data transfer, the "--connection-string" here
|
||||||
could be ignored or set it to your Ceilometer endpoint.
|
could be ignored or set it to your Ceilometer endpoint.
|
||||||
|
|
||||||
.. _Official Doc: http://docs.openstack.org/developer/osprofiler/background.html
|
.. _Official Doc: https://docs.openstack.org/osprofiler/latest/user/background.html
|
||||||
|
@ -84,4 +84,4 @@ Extending the GMR
|
|||||||
As mentioned above, additional sections can be added to the GMR for a
|
As mentioned above, additional sections can be added to the GMR for a
|
||||||
particular executable. For more information, see the inline documentation
|
particular executable. For more information, see the inline documentation
|
||||||
about oslo.reports:
|
about oslo.reports:
|
||||||
`oslo.reports <http://docs.openstack.org/developer/oslo.reports/>`_
|
`oslo.reports <https://docs.openstack.org/oslo.reports/latest/>`_
|
||||||
|
@ -181,4 +181,4 @@ Let's configure zaqar-bench too to use Keystone:
|
|||||||
authentication errors.
|
authentication errors.
|
||||||
|
|
||||||
|
|
||||||
.. _DevStack: http://docs.openstack.org/developer/devstack/
|
.. _DevStack: https://docs.openstack.org/devstack/latest/
|
||||||
|
@ -221,5 +221,5 @@ will happen in Zaqar's database.
|
|||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
|
||||||
.. _`Stevedore - Creating Plugins`: http://docs.openstack.org/developer/stevedore/tutorial/creating_plugins.html
|
.. _`Stevedore - Creating Plugins`: https://docs.openstack.org/stevedore/latest/user/tutorial/creating_plugins.html
|
||||||
.. _`Stevedore - Loading the Plugins`: http://docs.openstack.org/developer/stevedore/tutorial/loading.html
|
.. _`Stevedore - Loading the Plugins`: https://docs.openstack.org/stevedore/latest/user/tutorial/loading.html
|
||||||
|
@ -20,7 +20,7 @@ that you can use in developing Zaqar on Ubuntu or Fedora. These instructions
|
|||||||
assume that you are familiar with Git. Refer to GettingTheCode_ for
|
assume that you are familiar with Git. Refer to GettingTheCode_ for
|
||||||
additional information.
|
additional information.
|
||||||
|
|
||||||
.. _GettingTheCode: http://wiki.openstack.org/GettingTheCode
|
.. _GettingTheCode: https://wiki.openstack.org/wiki/Getting_The_Code
|
||||||
|
|
||||||
|
|
||||||
Virtual environments
|
Virtual environments
|
||||||
@ -39,7 +39,7 @@ virtual environment, instead of installing the packages at the system level.
|
|||||||
full integration testing or production usage. If you want to learn about
|
full integration testing or production usage. If you want to learn about
|
||||||
production best practices, check out the `OpenStack Operations Guide`_.
|
production best practices, check out the `OpenStack Operations Guide`_.
|
||||||
|
|
||||||
.. _`OpenStack Operations Guide`: http://docs.openstack.org/ops/
|
.. _`OpenStack Operations Guide`: https://docs.openstack.org/ops-guide/
|
||||||
|
|
||||||
Install GNU/Linux system dependencies
|
Install GNU/Linux system dependencies
|
||||||
#####################################
|
#####################################
|
||||||
@ -281,7 +281,7 @@ To do this, you first need to add the following setting to your ``local.conf``:
|
|||||||
|
|
||||||
Then run the ``stack.sh`` script as usual.
|
Then run the ``stack.sh`` script as usual.
|
||||||
|
|
||||||
.. _DevStack: http://docs.openstack.org/developer/devstack/
|
.. _DevStack: https://docs.openstack.org/devstack/latest/
|
||||||
|
|
||||||
Running tests
|
Running tests
|
||||||
-------------
|
-------------
|
||||||
|
@ -36,11 +36,11 @@ avoid hooks errors.
|
|||||||
Visit the `Gerrit Workflow's account setup`_ section in the wiki to get
|
Visit the `Gerrit Workflow's account setup`_ section in the wiki to get
|
||||||
more information on setting up your accounts.
|
more information on setting up your accounts.
|
||||||
|
|
||||||
.. _Launchpad: http://launchpad.net/
|
.. _Launchpad: https://launchpad.net/
|
||||||
.. _Gerrit: http://review.openstack.org/
|
.. _Gerrit: https://review.openstack.org/
|
||||||
.. _`Contributors License Agreement`: http://docs.openstack.org/infra/manual/developers.html#account-setup
|
.. _`Contributors License Agreement`: https://docs.openstack.org/infra/manual/developers.html#account-setup
|
||||||
.. _`join the OpenStack Foundation`: http://openstack.org/join
|
.. _`join the OpenStack Foundation`: https://www.openstack.org/join/
|
||||||
.. _`Gerrit Workflow's account setup`: http://docs.openstack.org/infra/manual/developers.html#account-setup
|
.. _`Gerrit Workflow's account setup`: https://docs.openstack.org/infra/manual/developers.html#account-setup
|
||||||
|
|
||||||
SSH setup
|
SSH setup
|
||||||
#########
|
#########
|
||||||
@ -193,7 +193,7 @@ working on bugs is to name the branch ``bug/BUG-NUMBER`` (for example,
|
|||||||
|
|
||||||
Read more about the commit syntax in the `Gerrit workflow`_ wiki.
|
Read more about the commit syntax in the `Gerrit workflow`_ wiki.
|
||||||
|
|
||||||
.. _`Gerrit workflow`: http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
.. _`Gerrit workflow`: https://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||||
|
|
||||||
Common problems
|
Common problems
|
||||||
^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^
|
||||||
|
@ -110,6 +110,6 @@ Review section`_ document.
|
|||||||
|
|
||||||
.. _`Open Zaqar fixes`: https://review.openstack.org/#/q/status:open+zaqar,n,z
|
.. _`Open Zaqar fixes`: https://review.openstack.org/#/q/status:open+zaqar,n,z
|
||||||
.. _`Git Commit Messages`: https://wiki.openstack.org/wiki/GitCommitMessages
|
.. _`Git Commit Messages`: https://wiki.openstack.org/wiki/GitCommitMessages
|
||||||
.. _`Gerrit Workflow Review section`: http://docs.openstack.org/infra/manual/developers.html#code-review
|
.. _`Gerrit Workflow Review section`: https://docs.openstack.org/infra/manual/developers.html#code-review
|
||||||
|
|
||||||
|
|
||||||
|
@ -16,7 +16,7 @@ Code reviews with Gerrit
|
|||||||
========================
|
========================
|
||||||
|
|
||||||
Zaqar uses the `Gerrit`_ tool to review proposed code changes. The review site
|
Zaqar uses the `Gerrit`_ tool to review proposed code changes. The review site
|
||||||
is http://review.openstack.org.
|
is https://review.openstack.org.
|
||||||
|
|
||||||
Gerrit is a complete replacement for GitHub pull requests. `All GitHub pull
|
Gerrit is a complete replacement for GitHub pull requests. `All GitHub pull
|
||||||
requests to the Zaqar repository will be ignored`.
|
requests to the Zaqar repository will be ignored`.
|
||||||
@ -25,4 +25,4 @@ See `Development Workflow with Gerrit`_ for more detailed documentation on how
|
|||||||
to work with Gerrit.
|
to work with Gerrit.
|
||||||
|
|
||||||
.. _Gerrit: https://www.gerritcodereview.com/
|
.. _Gerrit: https://www.gerritcodereview.com/
|
||||||
.. _Development Workflow with Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
.. _Development Workflow with Gerrit: https://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||||
|
@ -21,7 +21,7 @@ front-end is at http://jenkins.openstack.org. You must have an account on
|
|||||||
|
|
||||||
Jenkins performs tasks such as running static code analysis, running unit
|
Jenkins performs tasks such as running static code analysis, running unit
|
||||||
tests, and running functional tests. For more details on the jobs being run by
|
tests, and running functional tests. For more details on the jobs being run by
|
||||||
Jenkins, see the code reviews on http://review.openstack.org. Tests are run
|
Jenkins, see the code reviews on https://review.openstack.org. Tests are run
|
||||||
automatically and comments are put on the reviews automatically with the
|
automatically and comments are put on the reviews automatically with the
|
||||||
results.
|
results.
|
||||||
|
|
||||||
|
@ -50,7 +50,7 @@ for technical support requests.
|
|||||||
You can also reach us in ``#openstack-zaqar`` IRC channel at
|
You can also reach us in ``#openstack-zaqar`` IRC channel at
|
||||||
``irc.freenode.org``.
|
``irc.freenode.org``.
|
||||||
|
|
||||||
.. _Launchpad: http://launchpad.net
|
.. _Launchpad: https://launchpad.net
|
||||||
.. _Wiki: http://wiki.openstack.org
|
.. _Wiki: https://wiki.openstack.org
|
||||||
.. _Zaqar Team: https://launchpad.net/zaqar
|
.. _Zaqar Team: https://launchpad.net/zaqar
|
||||||
.. _Ask OpenStack: http://ask.openstack.org/
|
.. _Ask OpenStack: https://ask.openstack.org/
|
||||||
|
@ -160,6 +160,6 @@ bad designs, bad code, and bad blood.
|
|||||||
- No
|
- No
|
||||||
|
|
||||||
.. _`Why this is important?` : https://thoughtstreams.io/kgriffs/technical-communities/5060/
|
.. _`Why this is important?` : https://thoughtstreams.io/kgriffs/technical-communities/5060/
|
||||||
.. _`OpenStack Documentation Contributor Guide` : http://docs.openstack.org/contributor-guide/index.html
|
.. _`OpenStack Documentation Contributor Guide` : https://docs.openstack.org/contributor-guide/index.html
|
||||||
.. _`Wikipedia: Don't repeat yourself` : https://en.wikipedia.org/wiki/Don't_repeat_yourself
|
.. _`Wikipedia: Don't repeat yourself` : https://en.wikipedia.org/wiki/Don't_repeat_yourself
|
||||||
.. _`Wikipedia: You aren't gonna need it` : https://en.wikipedia.org/wiki/Don't_repeat_yourself
|
.. _`Wikipedia: You aren't gonna need it` : https://en.wikipedia.org/wiki/Don't_repeat_yourself
|
||||||
|
@ -88,7 +88,7 @@ When you run tests via ``tox -e py27`` command in the root directory of Zaqar:
|
|||||||
|
|
||||||
.. rubric:: Footnotes
|
.. rubric:: Footnotes
|
||||||
|
|
||||||
.. [#f1] See http://docs.openstack.org/developer/tempest/overview.html
|
.. [#f1] See https://docs.openstack.org/tempest/latest/#overview
|
||||||
|
|
||||||
.. _`OpenStack Tox testing manual` : https://wiki.openstack.org/wiki/Testing#Unit_Testing_with_Tox
|
.. _`OpenStack Tox testing manual` : https://wiki.openstack.org/wiki/Testing#Unit_Testing_with_Tox
|
||||||
.. _`Tox documentation` : https://tox.readthedocs.org/en/latest/
|
.. _`Tox documentation` : https://tox.readthedocs.org/en/latest/
|
||||||
|
@ -178,8 +178,8 @@ applications to get started.
|
|||||||
.. _`Bug Triage` : https://wiki.openstack.org/wiki/BugTriage
|
.. _`Bug Triage` : https://wiki.openstack.org/wiki/BugTriage
|
||||||
.. _`OpenStack development cycle` : https://wiki.openstack.org/wiki/ReleaseCycle
|
.. _`OpenStack development cycle` : https://wiki.openstack.org/wiki/ReleaseCycle
|
||||||
.. _`Launchpad Blueprints` : https://wiki.openstack.org/wiki/Blueprints
|
.. _`Launchpad Blueprints` : https://wiki.openstack.org/wiki/Blueprints
|
||||||
.. _`OpenStack Documentation Contributor Guide` : http://docs.openstack.org/contributor-guide/index.html
|
.. _`OpenStack Documentation Contributor Guide` : https://docs.openstack.org/contributor-guide/index.html
|
||||||
.. _`Zaqar's Contributor Documentation` : http://docs.openstack.org/developer/zaqar/
|
.. _`Zaqar's Contributor Documentation` : https://docs.openstack.org/zaqar/latest/
|
||||||
.. _`Zaqar's Wiki` : https://wiki.openstack.org/wiki/Zaqar
|
.. _`Zaqar's Wiki` : https://wiki.openstack.org/wiki/Zaqar
|
||||||
.. _`"openstack-manuals" project` : https://wiki.openstack.org/wiki/Documentation
|
.. _`"openstack-manuals" project` : https://wiki.openstack.org/wiki/Documentation
|
||||||
.. _`integrate Zaqar to the OpenStack Dashboard (Horizon)` : https://blueprints.launchpad.net/zaqar/+spec/zaqar-horizon-integration
|
.. _`integrate Zaqar to the OpenStack Dashboard (Horizon)` : https://blueprints.launchpad.net/zaqar/+spec/zaqar-horizon-integration
|
||||||
|
@ -6,4 +6,4 @@ Next steps
|
|||||||
Your OpenStack environment now includes the Messaging service.
|
Your OpenStack environment now includes the Messaging service.
|
||||||
|
|
||||||
To add additional services, see the
|
To add additional services, see the
|
||||||
`additional documentation on installing OpenStack <http://docs.openstack.org/#install-guides>`_ .
|
`additional documentation on installing OpenStack <https://docs.openstack.org/#install-guides>`_ .
|
||||||
|
@ -142,7 +142,7 @@ Messaging service Operations
|
|||||||
|
|
||||||
This section lists all of the operations that are available in the
|
This section lists all of the operations that are available in the
|
||||||
Messaging service API. This document uses some of the most common
|
Messaging service API. This document uses some of the most common
|
||||||
operations in `OpenStack API Reference <http://developer.openstack.org/api-guide/quick-start/index.html>`__..
|
operations in `OpenStack API Reference <https://developer.openstack.org/api-guide/quick-start/index.html>`__..
|
||||||
|
|
||||||
For details about all of the operations, see the Messaging service API v2
|
For details about all of the operations, see the Messaging service API v2
|
||||||
Reference.
|
Reference.
|
||||||
@ -322,7 +322,7 @@ Reference. All you need to get started with Messaging service is the
|
|||||||
getting started guide, the reference, and your Cloud account.
|
getting started guide, the reference, and your Cloud account.
|
||||||
|
|
||||||
For information about the OpenStack Zaqar API, see
|
For information about the OpenStack Zaqar API, see
|
||||||
`OpenStack API Reference <http://developer.openstack.org/api-guide/quick-start/index.html>`__.
|
`OpenStack API Reference <https://developer.openstack.org/api-guide/quick-start/index.html>`__.
|
||||||
|
|
||||||
This API uses standard HTTP 1.1 response codes as documented at
|
This API uses standard HTTP 1.1 response codes as documented at
|
||||||
`www.w3.org/Protocols/rfc2616/rfc2616-sec10.html <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html>`__.
|
`www.w3.org/Protocols/rfc2616/rfc2616-sec10.html <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html>`__.
|
||||||
|
@ -53,7 +53,7 @@ cURL, followed by the response.
|
|||||||
|
|
||||||
For a complete list of operations available for Message Queuing, see :doc:`getting_started`
|
For a complete list of operations available for Message Queuing, see :doc:`getting_started`
|
||||||
Each operation is fully described in the `Message Queuing API v2
|
Each operation is fully described in the `Message Queuing API v2
|
||||||
Reference <http://developer.openstack.org/api-ref/messaging>`_.
|
Reference <https://developer.openstack.org/api-ref/messaging/>`_.
|
||||||
|
|
||||||
Create Queue
|
Create Queue
|
||||||
------------
|
------------
|
||||||
|
@ -15,7 +15,7 @@
|
|||||||
|
|
||||||
"""oslo.i18n integration module.
|
"""oslo.i18n integration module.
|
||||||
|
|
||||||
See http://docs.openstack.org/developer/oslo.i18n/usage.html .
|
See https://docs.openstack.org/oslo.i18n/latest/user/usage.html .
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user