Doc page not displaying command-line with appropriate styling.

Bug #1559276 reported by Eddie Ramirez
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Dashboard (Horizon)
Fix Released
Low
Eddie Ramirez

Bug Description

This page http://docs.openstack.org/developer/horizon/testing.html contains instructions that tells the user how to start running tests for the Horizon project.

I've detected two things wrong:
1. There are some commands that are not properly formatted for visual purposes, e.g. mono-space font, enclosed in a box.
2. Single hyphens are replaced by en dashes,
      $ ./run_tests.sh –with-selenium –selenium-headless should be $ ./run_tests.sh --with-selenium --selenium-headless

*See image attached to this bug report*

If the user tries to execute the same commands, he/she will see the following error:

 $./run_tests.sh –with-selenium –selenium-headless
Checking environment.
Environment is up to date.
Traceback (most recent call last):
  File "/opt/stack/horizon/manage.py", line 23, in <module>
    execute_from_command_line(sys.argv)
  File "/opt/stack/horizon/.venv/local/lib/python2.7/site-packages/django/core/management/__init__.py", line 354, in execute_from_command_line
    utility.execute()
  File "/opt/stack/horizon/.venv/local/lib/python2.7/site-packages/django/core/management/__init__.py", line 303, in execute
    settings.INSTALLED_APPS
  File "/opt/stack/horizon/.venv/local/lib/python2.7/site-packages/django/conf/__init__.py", line 48, in __getattr__
    self._setup(name)
  File "/opt/stack/horizon/.venv/local/lib/python2.7/site-packages/django/conf/__init__.py", line 44, in _setup
    self._wrapped = Settings(settings_module)
  File "/opt/stack/horizon/.venv/local/lib/python2.7/site-packages/django/conf/__init__.py", line 92, in __init__
    mod = importlib.import_module(self.SETTINGS_MODULE)
  File "/usr/lib/python2.7/importlib/__init__.py", line 37, in import_module
    __import__(name)
ImportError: No module named –with-selenium

That is because there's no option named –with-selenium but --with-selenium.

Revision history for this message
Eddie Ramirez (ediardo) wrote :
Changed in horizon:
assignee: nobody → Eddie Ramirez (ediardo)
description: updated
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to horizon (master)

Fix proposed to branch: master
Review: https://review.openstack.org/294785

Changed in horizon:
status: New → In Progress
Changed in horizon:
importance: Undecided → Low
milestone: none → newton-1
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to horizon (master)

Reviewed: https://review.openstack.org/294785
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=48193a517c7dab39088714ecf5b9d40c8b5339e4
Submitter: Jenkins
Branch: master

commit 48193a517c7dab39088714ecf5b9d40c8b5339e4
Author: Eddie Ramirez <email address hidden>
Date: Fri Mar 18 19:53:11 2016 +0000

    Doc page not displaying command-line with appropriate styling

    The page locate at http://docs.openstack.org/developer/horizon/testing.html
    is not displaying commands with appropiate styling, for instance there are
    some command options using en dash instead of double hyphens.

    This patch fixes the way these lines should appear in the browser: using
    mono-spaced font, enclosed in a gray box and with double hyphens instead of
    en dashes. This way we prevent users seeing errors when copy-pasting the
    instructions.

    Change-Id: Id76675cd6510d0491cdc08d9cc845c0fc66ab2c6
    Closes-bug: #1559276

Changed in horizon:
status: In Progress → Fix Released
Revision history for this message
Davanum Srinivas (DIMS) (dims-v) wrote : Fix included in openstack/horizon 10.0.0.0b1

This issue was fixed in the openstack/horizon 10.0.0.0b1 development milestone.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.