[OpenStack-docs] RST admin user guide

Laurel Michaels lmichaels at tesora.com
Tue Apr 7 18:12:43 UTC 2015


I know this thread started with the admin user guide, but the bug that Anne created mentions the end user guide too, so here is a question about the end user guide.

End User Guide -- in the dashboard, the section called "Create and manage databases" is missing the last topic, which is "Update a database instance"

Old docbook page:

http://docs.openstack.org/user-guide/content/dashboard_databases.html#dashboard_update_db


New RST page:

http://docs-draft.openstack.org/34/170734/4/check/gate-openstack-manuals-tox-doc-publish-checkbuild/f15fa3e//publish-docs/draft/user-guide/content/enduser/dashboard_databases.html

I know why this happened -- the update section got added at the same time the RST version was being created.

I can add the update section to the RST. 

Question -- I know there are several people working on this bug simultaneously -- do I have to/should I assign the bug to me or should I not do that? Can I submit a Partial-Bug: #1440957 if the bug is not assigned to me? 

Sorry, just my ignorance speaking here :)

Thanks,

Laurel


________________________________________
From: Andreas Jaeger <aj at suse.com>
Sent: Tuesday, April 7, 2015 8:11 AM
To: Anne Gentle; Karen Bradshaw
Cc: openstack-docs at lists.openstack.org
Subject: Re: [OpenStack-docs] RST admin user guide

On 04/07/2015 04:50 AM, Anne Gentle wrote:
>
>
> On Mon, Apr 6, 2015 at 6:45 PM, Karen Bradshaw <kbhawkey at gmail.com
> <mailto:kbhawkey at gmail.com>> wrote:
>
>     Reading through the generated admin user guide, here is what I found
>     so far:
>     I am basing my findings on the files generated from my local build to,
>     user-guides/build-admin/html/index.html
>
>     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
>     <http://docs.openstack.org/user-guide/content/>/
>
>     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.
>
>
>
> Thanks Karen! Let's start tracking these with a doc bug in
> openstack-manuals:
> https://bugs.launchpad.net/openstack-manuals/+bug/1440957
>
> Then we can put Partial-bug: 1440957 in the commit messages for patches
> that address these.
>
> To answer the question 4, I think that "OLD" one was the original text
> for the Admin User Guide, and should be reversed (OLD goes with admin,
> NEW goes with End User).
>
> I've tried to address 2 with this patch:
> https://review.openstack.org/#/c/171025/ which also adds the missing
> config drive page.
>
> Thanks for the great eyes! I need a fresh pair after all the
> side-by-side comparisons!
> Anne

Thanks Karen for spotting these!

Issue number 4 addressed with:
https://review.openstack.org/171150

Andreas
--
  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
   SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
    GF: Felix Imendörffer, Jane Smithard, Jennifer Guild, Dilip Upmanyu,
        Graham Norton, HRB 21284 (AG Nürnberg)
     GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126


_______________________________________________
OpenStack-docs mailing list
OpenStack-docs at lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs



More information about the OpenStack-docs mailing list