Merge "Update the documentation link for doc migration"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
09563b6b2b
@ -1,15 +1,15 @@
|
||||
If you would like to contribute to the development of OpenStack,
|
||||
you must follow the steps documented at:
|
||||
|
||||
http://docs.openstack.org/developer/horizon/contributing.html
|
||||
https://docs.openstack.org/horizon/latest/contributor/contributing.html
|
||||
|
||||
or http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||
or https://docs.openstack.org/infra/manual/developers.html
|
||||
|
||||
Once those steps have been completed, changes to OpenStack
|
||||
should be submitted for review via the Gerrit tool, following
|
||||
the workflow documented at:
|
||||
|
||||
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.
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@ Horizon Style Commandments
|
||||
==========================
|
||||
|
||||
- Step 1: Read the OpenStack Style Commandments
|
||||
http://docs.openstack.org/developer/hacking/
|
||||
https://docs.openstack.org/hacking/latest/
|
||||
- Step 2: Read [hacking] section in tox.ini to find the list of names which
|
||||
can be imported directly without triggering the "H302: import only modules"
|
||||
flake8 warning
|
||||
@ -11,5 +11,6 @@ Horizon Style Commandments
|
||||
Horizon Specific Commandments
|
||||
-----------------------------
|
||||
|
||||
- Read the Horizon contributing documentation at http://docs.openstack.org/developer/horizon/contributing.html
|
||||
- Read the Horizon contributing documentation at
|
||||
https://docs.openstack.org/horizon/latest/contributor/contributing.html
|
||||
- [M322] Method's default argument shouldn't be mutable.
|
||||
|
||||
@ -6,9 +6,7 @@ The OpenStack Dashboard is a web-based interface that allows you to
|
||||
manage OpenStack resources and services. The Dashboard allows you to
|
||||
interact with the OpenStack Compute cloud controller using the OpenStack
|
||||
APIs. For more information about installing and configuring the
|
||||
Dashboard, see the `Installation Tutorials and Guides
|
||||
<https://docs.openstack.org/project-install-guide/ocata/>`__
|
||||
for your operating system.
|
||||
Dashboard, see the :doc:`/install/index` for your operating system.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
@ -27,12 +25,8 @@ for your operating system.
|
||||
manage-host-aggregates.rst
|
||||
admin-manage-stacks.rst
|
||||
|
||||
- To deploy the dashboard, see the `OpenStack dashboard documentation
|
||||
<https://docs.openstack.org/developer/horizon/topics/deployment.html>`__.
|
||||
- To deploy the dashboard, see the :doc:`/install/index`.
|
||||
- To launch instances with the dashboard as an end user, see the
|
||||
`Launch and manage instances
|
||||
<https://docs.openstack.org/user-guide/launch-instances.html>`__.
|
||||
in the OpenStack End User Guide.
|
||||
- To create and manage ports, see the `Create and manage networks
|
||||
<https://docs.openstack.org/user-guide/dashboard-create-networks.html#create-a-port>`__
|
||||
:doc:`/user/launch-instances` in the OpenStack End User Guide.
|
||||
- To create and manage ports, see the :doc:`/user/create-networks`
|
||||
section of the OpenStack End User Guide.
|
||||
|
||||
@ -293,7 +293,7 @@ Default:
|
||||
]
|
||||
},
|
||||
'bug_url': None,
|
||||
'help_url': "http://docs.openstack.org",
|
||||
'help_url': "https://docs.openstack.org/",
|
||||
'exceptions': {
|
||||
'recoverable': exceptions.RECOVERABLE,
|
||||
'not_found': exceptions.NOT_FOUND,
|
||||
@ -659,7 +659,7 @@ in that dictionary are:
|
||||
cluster for both purposes, since ceilometer was too slow for using with UI.
|
||||
Example: ``"receiver_connection_string": "mongodb://%s" % OPENSTACK_HOST``.
|
||||
|
||||
.. _osprofiler documentation: http://docs.openstack.org/developer/osprofiler/integration.html#how-to-initialize-profiler-to-get-one-trace-across-all-services
|
||||
.. _osprofiler documentation: https://docs.openstack.org/osprofiler/latest/user/integration.html#how-to-initialize-profiler-to-get-one-trace-across-all-services
|
||||
|
||||
OPENSTACK_SSL_CACERT
|
||||
--------------------
|
||||
@ -969,7 +969,7 @@ glance-api.conf file (see `here`_ how to do it). Set `allowed_origin` to the
|
||||
full hostname of Horizon web-server (e.g. http://<HOST_IP>/dashboard) and
|
||||
restart glance-api process.
|
||||
|
||||
.. _here: http://docs.openstack.org/developer/oslo.middleware/cors.html#configuration-for-oslo-config
|
||||
.. _here: https://docs.openstack.org/oslo.middleware/latest/reference/cors.html#configuration-for-oslo-config
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
@ -38,7 +38,7 @@ Whew! Got all that? Okay! You're good to go.
|
||||
|
||||
.. _`OpenStack Contributor License Agreement`: http://wiki.openstack.org/CLA
|
||||
.. _`Horizon Developers`: https://launchpad.net/~horizon
|
||||
.. _`instructions for setting up git-review`: http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||
.. _`instructions for setting up git-review`: https://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||
|
||||
Ways To Contribute
|
||||
------------------
|
||||
@ -474,10 +474,10 @@ To make a new release of the package, you need to:
|
||||
|
||||
.. _documentation: http://xstatic.rtfd.org/en/latest/packaging.html
|
||||
.. _xstatic-release: https://pypi.python.org/pypi/xstatic-release
|
||||
.. _`Create a new repository under OpenStack`: http://docs.openstack.org/infra/manual/creators.html
|
||||
.. _`Create a new repository under OpenStack`: https://docs.openstack.org/infra/manual/creators.html
|
||||
.. _`request a release`: http://git.openstack.org/cgit/openstack/releases/tree/README.rst
|
||||
.. _`releases repository`: http://git.openstack.org/cgit/openstack/releases
|
||||
.. _`Set up PyPi`: http://docs.openstack.org/infra/manual/creators.html#give-openstack-permission-to-publish-releases
|
||||
.. _`Set up PyPi`: https://docs.openstack.org/infra/manual/creators.html#give-openstack-permission-to-publish-releases
|
||||
.. _global-requirements: https://github.com/openstack/requirements/blob/master/global-requirements.txt
|
||||
|
||||
|
||||
@ -613,7 +613,7 @@ If the following applies to the patch, a release note is required:
|
||||
* It is not recommended that individual release notes use **prelude**
|
||||
section as it is for release highlights.
|
||||
|
||||
Horizon uses `reno <http://docs.openstack.org/developer/reno/usage.html>`_ to
|
||||
Horizon uses `reno <https://docs.openstack.org/reno/latest/user/usage.html>`_ to
|
||||
generate release notes. Please read the docs for details. In summary, use
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
@ -12,7 +12,7 @@ that Horizon supports in DevStack when ``stack.sh`` is run. If you need to use
|
||||
this with a stable branch you need to add ``stable/<branch name>`` to the end
|
||||
of each ``enable_plugin`` line (e.g. ``stable/mitaka``). You can also check
|
||||
out DevStack using a stable branch tag. For more information on DevStack,
|
||||
see https://docs.openstack.org/developer/devstack/
|
||||
see https://docs.openstack.org/devstack/latest/
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
@ -50,7 +50,8 @@ see https://docs.openstack.org/developer/devstack/
|
||||
# required to get networking properly configured in your environment.
|
||||
# This file is just using the defaults set up by devstack.
|
||||
# For a more detailed treatment of devstack network configuration
|
||||
# options, please see: http://devstack.org/guides/single-machine.html
|
||||
# options, please see:
|
||||
# https://docs.openstack.org/devstack/latest/guides.html
|
||||
|
||||
# Horizon is enabled by default in Devstack, but since we're developing
|
||||
# it's advised to use a separate clone. To disable horizon in DevStack,
|
||||
|
||||
@ -42,6 +42,6 @@ Adding a feature that was introduced in a microversion
|
||||
Microversion references
|
||||
=======================
|
||||
|
||||
:Nova: http://docs.openstack.org/developer/nova/api_microversion_history.html
|
||||
:Cinder: http://docs.openstack.org/developer/cinder/devref/api_microversion_history.html
|
||||
:API-WG: http://specs.openstack.org/openstack/api-wg/guidelines/microversion_specification.html
|
||||
:Nova: https://docs.openstack.org/nova/latest/reference/api-microversion-history.html
|
||||
:Cinder: https://docs.openstack.org/cinder/latest/contributor/api_microversion_history.html
|
||||
:API-WG: https://specs.openstack.org/openstack/api-wg/guidelines/microversion_specification.html
|
||||
|
||||
@ -15,7 +15,7 @@ translation to your code is not that hard and a requirement for horizon.
|
||||
|
||||
If you are interested in contributing translations, you may want to investigate
|
||||
`Zanata <https://translate.openstack.org>`_ and the
|
||||
`upstream translations <http://docs.openstack.org/developer/i18n/>`_.
|
||||
`upstream translations <https://docs.openstack.org/i18n/latest/>`_.
|
||||
You can visit the internationalization project IRC channel **#openstack-i18n**,
|
||||
if you need further assistance.
|
||||
|
||||
@ -65,7 +65,7 @@ translated. Lets break this up into steps we can follow:
|
||||
correctly. All creation of POT and PO files is handled by a daily upstream
|
||||
job. Further information can be found in the
|
||||
`translation infrastructure documentation
|
||||
<http://docs.openstack.org/developer/i18n/infra.html>`_.
|
||||
<https://docs.openstack.org/i18n/latest/infra.html>`_.
|
||||
|
||||
Message Substitution
|
||||
--------------------
|
||||
@ -99,7 +99,7 @@ process is entirely different. Lets walk through this process.
|
||||
|
||||
If you are setting up a project and need to know how to make it translatable,
|
||||
please refer to `this guide
|
||||
<http://docs.openstack.org/infra/manual/creators.html#enabling-translation-infrastructure>`_.
|
||||
<https://docs.openstack.org/infra/manual/creators.html#enabling-translation-infrastructure>`_.
|
||||
|
||||
.. _making_strings_translatable:
|
||||
|
||||
|
||||
@ -168,7 +168,7 @@ make calls into ``myservice.py``.
|
||||
This file is unnecessary in a purely Django based plugin, or if your Angular
|
||||
based plugin is relying on CORS support in the desired service. For more
|
||||
information on CORS, see
|
||||
`http://docs.openstack.org/admin-guide/cross_project_cors.html`
|
||||
https://docs.openstack.org/oslo.middleware/latest/admin/cross-project-cors.html
|
||||
|
||||
myservice.py
|
||||
------------
|
||||
@ -292,7 +292,7 @@ setup.cfg
|
||||
README.rst
|
||||
author = myname
|
||||
author_email = myemail
|
||||
home-page = http://docs.openstack.org/developer/horizon/
|
||||
home-page = https://docs.openstack.org/horizon/latest/
|
||||
classifiers = [
|
||||
Environment :: OpenStack
|
||||
Framework :: Django
|
||||
@ -451,7 +451,7 @@ This comes from the combination of the following two reasons.
|
||||
* OpenStack infra scripts assumes translation message catalogs are placed
|
||||
under ``<modulename>/locale`` (for example ``myplugin/locale``).
|
||||
|
||||
.. [#] http://docs.openstack.org/infra/manual/creators.html#enabling-translation-infrastructure
|
||||
.. [#] https://docs.openstack.org/infra/manual/creators.html#enabling-translation-infrastructure
|
||||
.. [#] https://docs.djangoproject.com/es/1.9/topics/i18n/translation/#how-django-discovers-translations
|
||||
|
||||
myplugin/locale
|
||||
|
||||
@ -58,7 +58,7 @@ the following documentation is provided.
|
||||
Release Notes
|
||||
=============
|
||||
|
||||
See http://docs.openstack.org/releasenotes/horizon/.
|
||||
See https://docs.openstack.org/releasenotes/horizon/.
|
||||
|
||||
Information
|
||||
===========
|
||||
|
||||
@ -13,19 +13,19 @@ System Requirements
|
||||
|
||||
* Python 2.7
|
||||
* Django 1.8
|
||||
* An accessible `keystone <https://docs.openstack.org/developer/keystone>`_ endpoint
|
||||
* An accessible `keystone <https://docs.openstack.org/keystone/latest/>`_ endpoint
|
||||
|
||||
* All other services are optional.
|
||||
Horizon supports the following services as of the Pike release.
|
||||
If the keystone endpoint for a service is configured,
|
||||
horizon detects it and enables its support automatically.
|
||||
|
||||
* `cinder <https://docs.openstack.org/developer/cinder>`_: Block Storage
|
||||
* `glance <https://docs.openstack.org/developer/glance>`_: Image Management
|
||||
* `heat <https://docs.openstack.org/developer/heat>`_: Orchestration
|
||||
* `neutron <https://docs.openstack.org/developer/neutron>`_: Networking
|
||||
* `nova <https://docs.openstack.org/developer/nova>`_: Compute
|
||||
* `swift <https://docs.openstack.org/developer/swift>`_: Object Storage
|
||||
* `cinder <https://docs.openstack.org/cinder/latest/>`_: Block Storage
|
||||
* `glance <https://docs.openstack.org/glance/latest/>`_: Image Management
|
||||
* `heat <https://docs.openstack.org/heat/latest/>`_: Orchestration
|
||||
* `neutron <https://docs.openstack.org/neutron/latest/>`_: Networking
|
||||
* `nova <https://docs.openstack.org/nova/latest/>`_: Compute
|
||||
* `swift <https://docs.openstack.org/swift/latest/>`_: Object Storage
|
||||
* Horizon also supports many other OpenStack services via plugins. For more
|
||||
information, see the :ref:`install-plugin-registry`.
|
||||
|
||||
|
||||
@ -18,9 +18,9 @@ and users. Once created, the resources are referred to as
|
||||
stacks.
|
||||
|
||||
The template languages are described in the `Template Guide
|
||||
<https://docs.openstack.org/developer/heat/template_guide/index.
|
||||
html>`_ in the `Heat developer documentation <http://docs.
|
||||
openstack.org/developer/heat/>`_.
|
||||
<https://docs.openstack.org/heat/latest/template_guide/index.
|
||||
html>`_ in the `Heat developer documentation <https://docs.
|
||||
openstack.org/heat/latest/>`_.
|
||||
|
||||
Launch a stack
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
@ -63,8 +63,8 @@ Community
|
||||
internationalizing, localizing and translating OpenStack projects
|
||||
is now available.
|
||||
|
||||
.. _creating a dashboard: http://docs.openstack.org/developer/horizon/topics/tutorial.html#creating-a-dashboard
|
||||
.. _creating a panel: http://docs.openstack.org/developer/horizon/topics/tutorial.html#creating-a-panel
|
||||
.. _creating a dashboard: https://docs.openstack.org/horizon/latest/contributor/tutorials/dashboard.html#creating-a-dashboard
|
||||
.. _creating a panel: https://docs.openstack.org/horizon/latest/contributor/tutorials/dashboard.html#creating-a-panel
|
||||
.. _thorough set of documentation: http://wiki.openstack.org/Translations
|
||||
|
||||
Under The Hood
|
||||
|
||||
@ -132,7 +132,7 @@ items loaded into Horizon can be altered. Editing the Django settings file is
|
||||
no longer required.
|
||||
|
||||
For more information see
|
||||
`Pluggable Settings <http://docs.openstack.org/developer/horizon/topics/settings.html#pluggable-settings-label>`__.
|
||||
`Pluggable Settings <https://docs.openstack.org/horizon/latest/configuration/pluggable_panels.html>`__.
|
||||
|
||||
Integration Test Framework
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@ -178,7 +178,7 @@ To change the behavior around hypervisor management in Horizon you must add the
|
||||
``local_settings.py`` file.
|
||||
|
||||
For more information see
|
||||
`OPENSTACK_HYPERVISOR_FEATURES setting <http://docs.openstack.org/developer/horizon/topics/settings.html#hypervisor-settings-label>`__.
|
||||
`OPENSTACK_HYPERVISOR_FEATURES setting <https://docs.openstack.org/horizon/latest/configuration/settings.html#openstack-hypervisor-features>`__.
|
||||
|
||||
Known Issues and Limitations
|
||||
============================
|
||||
|
||||
@ -10,13 +10,13 @@ Key New Features
|
||||
mechanism to use from those support by the deployment. This feature must be
|
||||
enabled by changes to local_settings.py to be utilized. The related settings
|
||||
to enable and configure can be found `here
|
||||
<http://docs.openstack.org/developer/horizon/topics/settings.html#websso-enabled>`__.
|
||||
<https://docs.openstack.org/horizon/latest/configuration/settings.html#websso-enabled>`__.
|
||||
|
||||
* Support for Theming -- A simpler mechanism to specify a custom theme for
|
||||
Horizon has been included. Allowing for use of CSS values for Bootstrap and
|
||||
Horizon variables, as well as the inclusion of custom CSS. More details
|
||||
available `here
|
||||
<http://docs.openstack.org/developer/horizon/topics/settings.html#custom-theme-path>`__
|
||||
<https://docs.openstack.org/horizon/latest/configuration/settings.html#custom-theme-path>`__
|
||||
|
||||
* Sahara UX Improvements -- Dramatic improvements to the Sahara user experience
|
||||
have been made with the addition of guided cluster creation and guided job
|
||||
|
||||
Loading…
Reference in New Issue
Block a user