End User Guide and Admin User Guide migration cleanup

[Anne Gentle]

1. First content item, How can I administer ...
The topics "cURL" and "horizon" should be active links to html pages?
2. In the Dashboard, missing "Manage projects and users",
missing "Manage volumes and volume types". "manage instances" should
be before "manage images" in the dashboard list.
3. There are formatting/markup errors in "Create and manage host aggregates" page. See the words "Procedure" and "Scheduling".
4. The dashboard's first paragraph has been updated. Is this correct?
OLD: As a cloud administrative user, the OpenStack dashboard lets you create and manage projects, users, images, and flavors. You can also set quotas and create and manage services. For information about using the dashboard to perform end user tasks, see the OpenStack End User Guide

NEW: As a cloud end user, you can use the OpenStack dashboard to provision your own resources within the limits set by administrators. You can modify the examples provided in this section to create other types and sizes of server instances.

5. Also, check the order of the command line clients in the admin user index.

6. There are a number of columns/screen output, in the command line client pages, that overflow the boundaries of a table. See "Manage projects, users, roles", "Manage Project Security", for an example.

7. Fix common/cli_manage_images.rst to use .. code-block:: json. Check that Pygments is working correctly. The output should display numbered lines of highlight code. Also move indented list in note over to left so that text is sized correctly?

8. Possibly, create a common intro.rst file for both admin and user guides. The content is mostly identical.

9. Fix adminuser/dashboard_set_quotas.rst. There appeared to be a spacing error of the admin_only tag at the top of the file. The page was
getting included in the end user guide.

10. Fixing inline markup in analyzing-log-files-with-swift-cli.rst.

[Anne Gentle (annegentle)]

I think the OLD above should remain in the admin user guide, and the NEW looks like it was the end user text. Sounds like the text needs an update.

[Andreas Jaeger (jaegerandi)]

Anne has taking care of number 2, my change is for number 4.

[Karen Bradshaw (kbhawkey)]

I will look at #1 and #3 unless someone has started on these.

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/171150
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=549a6efe9f2f01aa6b374ffd97fc1b2736d0a29b
Submitter: Jenkins
Branch: master

commit 549a6efe9f2f01aa6b374ffd97fc1b2736d0a29b
Author: Andreas Jaeger <email address hidden>
Date: Tue Apr 7 14:03:55 2015 +0200

    User Guides: Fix dashboard intros

    Add specific text for both version of the guides to dashboard intro and
    mark it conditional using the :only: directive.

    Also, remove unused ifconfig Sphinx extension.

    Partial-Bug: #1440957

    Change-Id: I6849989a8ae34638935f76efc174ff909a7a441c

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/171025
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=5c75689027ef3309b40b24234a2151cc82dbaab9
Submitter: Jenkins
Branch: master

commit 5c75689027ef3309b40b24234a2151cc82dbaab9
Author: Anne Gentle <email address hidden>
Date: Mon Apr 6 21:31:28 2015 -0500

    Adds "Store metadata on a config drive" content and updates TOCs

    Partial-bug: 1440957

    Change-Id: Iae5b0c5039d2ec9143a615638051be3663456129

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/171234
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=49cdf2d49e18d8eea695e895dff06dae440b742b
Submitter: Jenkins
Branch: master

commit 49cdf2d49e18d8eea695e895dff06dae440b742b
Author: Karen Bradshaw <email address hidden>
Date: Tue Apr 7 10:39:55 2015 -0400

    Fix minor RST markup and formatting

    -Remove asterisks from Scheduling link label.
    -Remove word Procedure from section headers.
    -Add emphasis to +/- click commands.
    -Changed second section header text.

    Change-Id: I9befa32320458a0cfcac07c6d3ae5dde0f9cd72b
    Partial-Bug: 1440957

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/171352
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=70ad4a12229838ca127b8f6fc96aad3bc40d4da8
Submitter: Jenkins
Branch: master

commit 70ad4a12229838ca127b8f6fc96aad3bc40d4da8
Author: Laurel Michaels <email address hidden>
Date: Tue Apr 7 16:11:44 2015 -0400

    Add update section to dashboard_databases.rst

    The update section was present in the old
    docbook version, but missing in the migrated
    RST version.

    This happened because the docbook update section
    merged at the same time the RST file was being
    created.

    Change-Id: Ic341121c8248cbb3805659674a9494e3de15437a
    Partial-Bug: #1440957

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/171245
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=a6d6802669af36775186f018ff94d9ec8dd77c6a
Submitter: Jenkins
Branch: master

commit a6d6802669af36775186f018ff94d9ec8dd77c6a
Author: Karen Bradshaw <email address hidden>
Date: Tue Apr 7 11:05:39 2015 -0400

    Fix cURL and horizon links

    -Added links for cURL and horizon in intro-admin.rst.

    Change-Id: I46b4cfc9539328f8bbfb9be5d0d0d8801166e5ff
    Partial-Bug: 1440957

[Karen Bradshaw (kbhawkey)]

I have #7 done and added the links (cuRL and horizon) to intro.rst.

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/171698
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=c86b6e970a0d9a40ed104803f8d103bc43e26b57
Submitter: Jenkins
Branch: master

commit c86b6e970a0d9a40ed104803f8d103bc43e26b57
Author: Karen Bradshaw <email address hidden>
Date: Wed Apr 8 11:35:44 2015 -0400

    Update RST markup, fix intro.rst links

    -Changed RST markup for note that includes
    json code block.
    -Update end user guide, intro.rst, to
    include cURL and horizon links.

    Change-Id: I024af5f578ae3779cc44b0cb851d6e14453b5273
    Partial-Bug: 1440957

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/171808
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=393b6986a70e133a4265c0410b38808e59abe886
Submitter: Jenkins
Branch: master

commit 393b6986a70e133a4265c0410b38808e59abe886
Author: Karen Bradshaw <email address hidden>
Date: Wed Apr 8 16:22:05 2015 -0400

    Fix formatting of admin_only tag

    Fix admin_only tag in dashboard_set_quotas.rst.
    File was being included in end user guide.

    Change-Id: I1f74db2b4d5cca7e1e8d08c6f7c32c160548acbe
    Partial-Bug: 1440957

[Karen Bradshaw (kbhawkey)]

What is the status of providing code highlighting in the Python SDK section or for any
section of code in the RST version of the admin and end user guides? These areas currently have
a black background. It would be easier to read the code if the highlighting was enabled.

[Anne Gentle (annegentle)]

Karen, the way I understand it, you can change the RST source to indicate that the code snippet is python. And then with the 1.0.6 or higher theme you will see python highlights like this example:

http://docs-draft.openstack.org/23/170023/3/gate/gate-openstackdocstheme-docs/52c8e79//doc/build/html/

Does that help?

[Karen Bradshaw (kbhawkey)]

Hi, Anne. Thanks for the reply.
I added json highlighting to another file and did not see any changes,
except line numbers appeared. Perhaps I did not add the correct directives
for RST.
I will double check. Is it okay to add code highlighting to the Python SDK
portion of the end user guide?
I see the highlighting in the Demo page link that you sent. Is the black
background part of this theme and is it preferred. I noticed that the RST
developer docs look different.
-Karen

On Wed, Apr 15, 2015 at 9:35 AM, Anne Gentle <email address hidden> wrote:

> Karen, the way I understand it, you can change the RST source to
> indicate that the code snippet is python. And then with the 1.0.6 or
> higher theme you will see python highlights like this example:
>
> http://docs-draft.openstack.org/23/170023/3/gate/gate-
> openstackdocstheme-docs/52c8e79//doc/build/html/
>
> Does that help?
>
> --
> You received this bug notification because you are a bug assignee.
> https://bugs.launchpad.net/bugs/1440957
>
> Title:
> End User Guide and Admin User Guide migration cleanup
>
> Status in OpenStack Manuals:
> In Progress
>
> Bug description:
> 1. First content item, How can I administer ...
> The topics "cURL" and "horizon" should be active links to html pages?
> 2. In the Dashboard, missing "Manage projects and users",
> missing "Manage volumes and volume types". "manage instances" should
> be before "manage images" in the dashboard list.
> 3. There are formatting/markup errors in "Create and manage host
> aggregates" page. See the words "Procedure" and "Scheduling".
> 4. The dashboard's first paragraph has been updated. Is this correct?
> OLD: As a cloud administrative user, the OpenStack dashboard lets you
> create and manage projects, users, images, and flavors. You can also set
> quotas and create and manage services. For information about using the
> dashboard to perform end user tasks, see the OpenStack End User Guide
>
> NEW: As a cloud end user, you can use the OpenStack dashboard to
> provision your own resources within the limits set by administrators.
> You can modify the examples provided in this section to create other
> types and sizes of server instances.
>
> 5. Also, check the order of the command line clients in the admin user
> index.
>
> 6. There are a number of columns/screen output, in the command line
> client pages, that overflow the boundaries of a table. See "Manage
> projects, users, roles", "Manage Project Security", for an example.
>
> 7. Fix common/cli_manage_images.rst to use .. code-block:: json.
> Check that Pygments is working correctly. The output should display
> numbered lines of highlight code. Also move indented list in note over
> to left so that text is sized correctly?
>
> 8. Possibly, create a common intro.rst file for both admin and user
> guides. The content is mostly identical.
>
> 9. Fix adminuser/dashboard_set_quotas.rst. There appeared to be a
> spacing error of the admin_only tag at the top of the file. The page was
> getting included in the end user guide.
>
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/ope...

[OpenStack Infra (hudson-openstack)]

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

[Anne Gentle (annegentle)]

Hi Karen, generally if a design aspect is in http://openstack-homepage.bitballoon.com/docs/book I consider that the "spec" design.

Yes, please do add code highlighting directives for the Python code samples, thanks!

[Karen Bradshaw (kbhawkey)]

I put in a patch addressing #10.

[Karen Bradshaw (kbhawkey)]

Hi, Anne. I just looked at the generated docs page source and compared to
the
Demo documentation page source. The Demo documentation page source has a
link
to the Pygments stylesheet. My generated version of the end user guide
does not contain a
reference to pygments (native.css). Is this correct? I think the end user
guide already has markup to turn on python code highlighting.
Thanks!
-Karen

On Wed, Apr 15, 2015 at 10:14 AM, Anne Gentle <email address hidden> wrote:

> Hi Karen, generally if a design aspect is in http://openstack-
> homepage.bitballoon.com/docs/book I consider that the "spec" design.
>
> Yes, please do add code highlighting directives for the Python code
> samples, thanks!
>
> --
> You received this bug notification because you are a bug assignee.
> https://bugs.launchpad.net/bugs/1440957
>
> Title:
> End User Guide and Admin User Guide migration cleanup
>
> Status in OpenStack Manuals:
> In Progress
>
> Bug description:
> 1. First content item, How can I administer ...
> The topics "cURL" and "horizon" should be active links to html pages?
> 2. In the Dashboard, missing "Manage projects and users",
> missing "Manage volumes and volume types". "manage instances" should
> be before "manage images" in the dashboard list.
> 3. There are formatting/markup errors in "Create and manage host
> aggregates" page. See the words "Procedure" and "Scheduling".
> 4. The dashboard's first paragraph has been updated. Is this correct?
> OLD: As a cloud administrative user, the OpenStack dashboard lets you
> create and manage projects, users, images, and flavors. You can also set
> quotas and create and manage services. For information about using the
> dashboard to perform end user tasks, see the OpenStack End User Guide
>
> NEW: As a cloud end user, you can use the OpenStack dashboard to
> provision your own resources within the limits set by administrators.
> You can modify the examples provided in this section to create other
> types and sizes of server instances.
>
> 5. Also, check the order of the command line clients in the admin user
> index.
>
> 6. There are a number of columns/screen output, in the command line
> client pages, that overflow the boundaries of a table. See "Manage
> projects, users, roles", "Manage Project Security", for an example.
>
> 7. Fix common/cli_manage_images.rst to use .. code-block:: json.
> Check that Pygments is working correctly. The output should display
> numbered lines of highlight code. Also move indented list in note over
> to left so that text is sized correctly?
>
> 8. Possibly, create a common intro.rst file for both admin and user
> guides. The content is mostly identical.
>
> 9. Fix adminuser/dashboard_set_quotas.rst. There appeared to be a
> spacing error of the admin_only tag at the top of the file. The page was
> getting included in the end user guide.
>
> 10. Fixing inline markup in analyzing-log-files-with-swift-cli.rst.
>
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/openstack-manuals/+bug/1440957/+subscriptions
>

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/173899
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=d0db933a7e74e5fbf8caee311e68099c9cc018ea
Submitter: Jenkins
Branch: master

commit d0db933a7e74e5fbf8caee311e68099c9cc018ea
Author: Karen Bradshaw <email address hidden>
Date: Wed Apr 15 10:04:09 2015 -0400

    Minor RST markup fix, analyze log files

    Update RST formatting for swift command line
    arguments, 'output' and 'o'.

    Change-Id: Ib39f890c4a6d0292dc7c8cc6c6c0f647271fdccd
    Partial-Bug: 1440957