os=".." used in configuration guide

Bug #1232864 reported by Andreas Jaeger
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-manuals
Fix Released
Medium
Andreas Jaeger

Bug Description

One example to show the problem:

Check:
http://docs.openstack.org/trunk/config-reference/content/dashboard-custom-brand.html

it contains at the end:
8. Restart apache:

$ sudo service apache2 restart
$ sudo service httpd restart
$ sudo service apache2 restart

This comes from:
            <step>
               <para>Restart apache:</para>
               <screen os="ubuntu">
                  <prompt>$</prompt>
                  <userinput>sudo service apache2 restart</userinput>
               </screen>
               <screen os="centos;fedora;rhel">
                  <prompt>$</prompt>
                  <userinput>sudo service httpd restart</userinput>
               </screen>
               <screen os="opensuse">
                  <prompt>$</prompt>
                  <userinput>sudo service apache2 restart</userinput>
               </screen>
            </step>

There should be only one version of this - or a proper attribution to say what is relevant for which distribution.

There are more places where os="..." is used in the guide - mainly via included files. All should be reworked.

Revision history for this message
koolhead17 (koolhead17) wrote :

Andreas,

You are right, we should append lines above commands mentioning the command X is for Distro A.

Tom Fifield (fifieldt)
Changed in openstack-manuals:
status: New → Triaged
importance: Undecided → Medium
milestone: none → havana
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-manuals (master)

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

Changed in openstack-manuals:
assignee: nobody → Andreas Jaeger (jaegerandi)
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-manuals (master)

Reviewed: https://review.openstack.org/50852
Committed: http://github.com/openstack/openstack-manuals/commit/93140c94537651413b511e1866c7d9dd8587a0ae
Submitter: Jenkins
Branch: master

commit 93140c94537651413b511e1866c7d9dd8587a0ae
Author: Andreas Jaeger <email address hidden>
Date: Thu Oct 10 09:20:09 2013 +0200

    Do not use os= in Config Reference

    The Config Reference does not profile for the os variable and thus
    all occurences of os=... are shown which leads to confusion. Add proper
    wording for all examples.

    Change-Id: I77c81b92e95d1b8737b507ea439a9622ebc3d6f1
    Closes-Bug: #1232864

Changed in openstack-manuals:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/50871
Committed: http://github.com/openstack/openstack-manuals/commit/ea3d32ac3113ff2f74b50a4400272d12b7386529
Submitter: Jenkins
Branch: master

commit ea3d32ac3113ff2f74b50a4400272d12b7386529
Author: Andreas Jaeger <email address hidden>
Date: Thu Oct 10 11:04:21 2013 +0200

    Do not use os="..." in Cloud Admin Guide

    The Cloud Admin Guide does not profile for the os variable and thus
    all occurences of os=... are shown which leads to confusion. Add proper
    wording for all examples.

    Change-Id: Ib6a651dcfe23cbaad7b727658813c14f36aea73b
    Closes-Bug: #1232864

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.