openstack/horizon
Code Issues Proposed changes

doc: cleanup unnecessary vertical lines

Browse Source 
If a content has unnecessary indent, we will have unnecessary
vertical gray lines in rendered HTML like [1].

[1] https://docs.openstack.org/horizon/latest/configuration/customizing.html#icons

Change-Id: I69140e396db80c5008d60db64b83f7cdb5a891d8
This commit is contained in:
Akihiro Motoki 2018-01-14 05:45:35 +09:00
parent 794fec40f9
commit 5a11dd64b1
7 changed files with 15 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/admin/manage-volumes.rst
View File

@ -114,12 +114,12 @@ volumes.
`*` Source `NIST SP 800-38E <http://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38e.pdf>`_ `*` Source `NIST SP 800-38E <http://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38e.pdf>`_
.. note:: .. note::
To see further information and CLI instructions, see To see further information and CLI instructions, see
`Create an encrypted volume type `Create an encrypted volume type
<https://docs.openstack.org/cinder/latest/configuration/block-storage/volume-encryption.html>`__ <https://docs.openstack.org/cinder/latest/configuration/block-storage/volume-encryption.html>`__
in the OpenStack Configuration Reference. in the OpenStack Configuration Reference.
Delete volume types Delete volume types
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~

4
doc/source/configuration/customizing.rst
View File

@ -302,7 +302,9 @@ instructions on how to use icons in the code.
To add icon to Table Action, use icon property. Example: To add icon to Table Action, use icon property. Example:
class CreateSnapshot(tables.LinkAction): .. code-block:: python
class CreateSnapshot(tables.LinkAction):
name = "snapshot" name = "snapshot"
verbose_name = _("Create Snapshot") verbose_name = _("Create Snapshot")
icon = "camera" icon = "camera"

4
doc/source/contributor/faq.rst
View File

@ -5,7 +5,6 @@ Frequently Asked Questions
========================== ==========================
What is the relationship between ``Dashboards``, ``Panels``, and navigation? What is the relationship between ``Dashboards``, ``Panels``, and navigation?
The navigational structure is strongly encouraged to flow from The navigational structure is strongly encouraged to flow from
``Dashboard`` objects as top-level navigation items to ``Panel`` objects as ``Dashboard`` objects as top-level navigation items to ``Panel`` objects as
sub-navigation items as in the current implementation. Template tags sub-navigation items as in the current implementation. Template tags
@ -15,7 +14,6 @@ What is the relationship between ``Dashboards``, ``Panels``, and navigation?
templates and URLconfs by hand to create any desired structure. templates and URLconfs by hand to create any desired structure.
Does a panel have to be an app in ``INSTALLED_APPS``? Does a panel have to be an app in ``INSTALLED_APPS``?
A panel can live in any Python module. It can be a standalone which ties A panel can live in any Python module. It can be a standalone which ties
into an existing dashboard, or it can be contained alongside others within into an existing dashboard, or it can be contained alongside others within
a larger dashboard "app". There is no strict enforcement here. Python a larger dashboard "app". There is no strict enforcement here. Python
@ -24,14 +22,12 @@ Does a panel have to be an app in ``INSTALLED_APPS``?
convenient way to load a standalone panel. convenient way to load a standalone panel.
Could I hook an external service into a panel using, for example, an iFrame? Could I hook an external service into a panel using, for example, an iFrame?
Panels are just entry-points to hook views into the larger dashboard Panels are just entry-points to hook views into the larger dashboard
navigational structure and enforce common attributes like RBAC. The navigational structure and enforce common attributes like RBAC. The
views and corresponding templates can contain anything you would like, views and corresponding templates can contain anything you would like,
including iFrames. including iFrames.
What does this mean for visual design? What does this mean for visual design?
The ability to add an arbitrary number of top-level navigational items The ability to add an arbitrary number of top-level navigational items
(``Dashboard`` objects) poses a new design challenge. Horizon's lead (``Dashboard`` objects) poses a new design challenge. Horizon's lead
designer has taken on the challenge of providing a reference design designer has taken on the challenge of providing a reference design

2
doc/source/contributor/topics/packaging.rst
View File

@ -215,4 +215,4 @@ This is the `recommended way`_ for Django applications.
Depending on configuration, it might be required to ``manage.py compress`` Depending on configuration, it might be required to ``manage.py compress``
during package build, too. during package build, too.
.. _`recommended way`: https://docs.djangoproject.com/en/dev/howto/static-files/deployment/ .. _`recommended way`: https://docs.djangoproject.com/en/dev/howto/static-files/deployment/

4
doc/source/glossary.rst
View File

@ -5,22 +5,18 @@ Glossary
======== ========
Horizon Horizon
The OpenStack dashboard project. Also the name of the top-level The OpenStack dashboard project. Also the name of the top-level
Python object which handles registration for the app. Python object which handles registration for the app.
Dashboard Dashboard
A Python class representing a top-level navigation item (e.g. "project") A Python class representing a top-level navigation item (e.g. "project")
which provides a consistent API for Horizon-compatible applications. which provides a consistent API for Horizon-compatible applications.
Panel Panel
A Python class representing a sub-navigation item (e.g. "instances") A Python class representing a sub-navigation item (e.g. "instances")
which contains all the necessary logic (views, forms, tests, etc.) for which contains all the necessary logic (views, forms, tests, etc.) for
that interface. that interface.
Project Project
Used in user-facing text in place of the term "Tenant" which is Keystone's Used in user-facing text in place of the term "Tenant" which is Keystone's
word. word.

6
horizon/tables/actions.py
View File

@ -228,8 +228,10 @@ class Action(BaseAction):
list of scope and rule tuples to do policy checks on, the list of scope and rule tuples to do policy checks on, the
composition of which is (scope, rule) composition of which is (scope, rule)
scope: service type managing the policy for action * scope: service type managing the policy for action
rule: string representing the action to be checked * rule: string representing the action to be checked
.. code-block:: python
for a policy that requires a single rule check: for a policy that requires a single rule check:
policy_rules should look like policy_rules should look like

4
openstack_auth/utils.py
View File

@ -210,14 +210,14 @@ def get_websso_url(request, auth_url, websso_auth):
The value in WEBSSO_IDP_MAPPING is expected to be a tuple formatted as The value in WEBSSO_IDP_MAPPING is expected to be a tuple formatted as
(<idp_id>, <protocol_id>). Using the values found, a IdP/protocol (<idp_id>, <protocol_id>). Using the values found, a IdP/protocol
specific URL will be constructed: specific URL will be constructed::
/auth/OS-FEDERATION/identity_providers/<idp_id> /auth/OS-FEDERATION/identity_providers/<idp_id>
/protocols/<protocol_id>/websso /protocols/<protocol_id>/websso
If no value is found from the WEBSSO_IDP_MAPPING dictionary, it will If no value is found from the WEBSSO_IDP_MAPPING dictionary, it will
treat the value as the global WebSSO protocol <protocol_id> and treat the value as the global WebSSO protocol <protocol_id> and
construct the WebSSO URL by: construct the WebSSO URL by::
/auth/OS-FEDERATION/websso/<protocol_id> /auth/OS-FEDERATION/websso/<protocol_id>