better manual page with description needed for keystone-manage

Bug #878759 reported by koolhead17
12
This bug affects 2 people
Affects Status Importance Assigned to Milestone
OpenStack Identity (keystone)
Invalid
Low
koolhead17

Bug Description

Hi,
Currently the man page for keystone, keystone-manage seems less descriptive. Better description needed.

koolhead17 (koolhead17)
Changed in keystone:
assignee: nobody → koolhead17 (koolhead17)
Revision history for this message
koolhead17 (koolhead17) wrote :

I am working on the same and hence assigned it to myself!! :)

Revision history for this message
Dolph Mathews (dolph) wrote :

I just fixed the `keystone-manage --help` response, which was basically broken.

I can't get a proper man page for keystone/manage at all-- are you creating one?

Revision history for this message
koolhead17 (koolhead17) wrote :

@Dolph

I will be working on Keystone commands in few days, i will add most options with examples.
 i don`t know how man-pages are created but i will learn it and then get back to you. :D

Revision history for this message
Openstack Gerrit (openstack-gerrit) wrote : Fix merged to keystone (master)

Reviewed: https://review.openstack.org/1005
Committed: http://github.com/openstack/keystone/commit/8dcd49d8e48122909a262448c0c0ca3337348837
Submitter: Jenkins
Branch: master

 status fixcommitted
 done

commit 8dcd49d8e48122909a262448c0c0ca3337348837
Author: Dolph Mathews <email address hidden>
Date: Thu Oct 20 15:09:45 2011 -0500

    Revised documentation

    - Eliminated all but 1 Sphinx build warning
      - I think the last one is being addressed by bug #878759
    - Pointed contributors to http://keystone.openstack.org/

    Change-Id: I20c26909034b15d46f78c90582238f44dd859d83

Changed in keystone:
status: New → Fix Committed
Revision history for this message
Dolph Mathews (dolph) wrote : Re: better manual page with description needed for keystone.

I ran `python setup.py build_sphinx` and noticed that the presence of `doc/source/man/keystonemanage.rst` is causing a warning because it's not being referenced from the other docs... but I couldn't find that file referenced by *anything*.

If you're not using it as part of your fix, please delete it in your patch to avoid confusion; thanks!

Changed in keystone:
status: Fix Committed → In Progress
Revision history for this message
Joseph Heck (heckj) wrote :

I linked that "man" page in with the rest of the developer documentation, but it's still needing some work around EndpointTemplates. Was planning on hitting this as I continue into bug #843056. Is this bug still relevant in light of that?

Revision history for this message
Dolph Mathews (dolph) wrote :

I like the idea of man pages being available through keystone.openstack.org, but the content of that rst is grossly out of date, and needs a lot of help if it's going to stick around.

@koolhead17: can you give us an update on progress/direction?

Revision history for this message
Dolph Mathews (dolph) wrote :

Related note: The `keystonemanage.rst` file I mentioned above is (as of today) being published on http://keystone.openstack.org/ under Man Pages.

Revision history for this message
koolhead17 (koolhead17) wrote :

@Dolph

Looks perfect, let me see what all i can add in it. :)

Revision history for this message
Openstack Gerrit (openstack-gerrit) wrote : Fix merged to keystone (stable/diablo)

Reviewed: https://review.openstack.org/1344
Committed: http://github.com/openstack/keystone/commit/fe3777d7b311965b0d3442de6633dc1e68c83a18
Submitter: Jenkins
Branch: stable/diablo

 status fixcommitted
 done

commit fe3777d7b311965b0d3442de6633dc1e68c83a18
Author: Dolph Mathews <email address hidden>
Date: Thu Oct 20 15:09:45 2011 -0500

    Revised documentation

    - Eliminated all but 1 Sphinx build warning
      - I think the last one is being addressed by bug #878759
    - Pointed contributors to http://keystone.openstack.org/

    Change-Id: I20c26909034b15d46f78c90582238f44dd859d83

Changed in keystone:
status: In Progress → Fix Committed
Thierry Carrez (ttx)
Changed in keystone:
milestone: none → essex-1
Dolph Mathews (dolph)
Changed in keystone:
importance: Undecided → Low
milestone: essex-1 → essex-2
status: Fix Committed → In Progress
Thierry Carrez (ttx)
Changed in keystone:
milestone: essex-2 → essex-3
summary: - better manual page with description needed for keystone.
+ better manual page with description needed for keystone-manage
tags: added: keystone-manage
Changed in keystone:
milestone: essex-3 → essex-4
Revision history for this message
Dolph Mathews (dolph) wrote :

I don't think this is applicable to the current codebase; additionally, the CLI is being rewritten as part of python-keystoneclient.

Changed in keystone:
status: In Progress → Invalid
Thierry Carrez (ttx)
Changed in keystone:
milestone: essex-4 → none
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.