Keystone docs need to be migrated from the OpenStack-manuals

Bug #1694460 reported by Samriddhi
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Identity (keystone)
Fix Released
High
Lance Bragstad

Bug Description

The docs related to keystone identity, currently present in OpenStack-manuals[1], need to be migrated to the keystone repository. The docs should be added so that they can be reviewed by Keystone developers and corresponding inconsistencies could be removed.
[1]: https://github.com/openstack/openstack-manuals

Samriddhi (s-jain)
tags: added: documentation
Changed in keystone:
assignee: nobody → Samriddhi (s-jain)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to keystone (master)

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

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

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on keystone (master)

Change abandoned by Samriddhi (<email address hidden>) on branch: master
Review: https://review.openstack.org/469162

Revision history for this message
Lance Bragstad (lbragstad) wrote :

For clarity, the process for moving the guides into the various projects has been documented in a specification proposed to the docs-specs repository [0].

Thanks for picking up this work!

[0] https://review.openstack.org/#/c/472275/

Changed in keystone:
milestone: none → pike-3
importance: Undecided → High
Revision history for this message
Lance Bragstad (lbragstad) wrote :

Setting the priority here to high since it's a community wide initiative for docs.

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

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on keystone (master)

Change abandoned by Samriddhi (<email address hidden>) on branch: master
Review: https://review.openstack.org/474542

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Change abandoned by Samriddhi (<email address hidden>) on branch: master
Review: https://review.openstack.org/474543

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

Reviewed: https://review.openstack.org/469515
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=aba92673238984f98a42005bd7f27940c72cc419
Submitter: Jenkins
Branch: master

commit aba92673238984f98a42005bd7f27940c72cc419
Author: Samriddhi Jain <email address hidden>
Date: Wed May 31 20:01:23 2017 +0530

    Added keystone admin guides to documentation

    Currently the identity administrator guide docs are a part of
    general OpenStack-manuals. Migrating those docs to keystone
    documentation so that they can be reviewed effectively by
    keystone developers too.

    Partial-Bug #1694460
    Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454

    Change-Id: Id121ae1dd5bce993b4ad1219b592527ef0047063

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/474545
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=c69c283bf8dfab7356763788c2760a4656671410
Submitter: Jenkins
Branch: master

commit c69c283bf8dfab7356763788c2760a4656671410
Author: Samriddhi Jain <email address hidden>
Date: Thu Jun 15 12:37:40 2017 +0530

    Added keystone installation guides

    Currently some keystone installation guide docs are part of
    general OpenStack-manuals. Migrating those docs to keystone
    documentation so that they can be reviewed effectively by
    keystone developers too.

    Added installation guides for Ubuntu, openSUSE and
    Red Hat Enterprise. The installation guides for Debian will
    be added once they are complete in openstack-manuals.

    Also changed the toctree structure in install-guides to
    include directives so that all sections appear on one page
    rather than just links.

    Partial-Bug #1694460

    Change-Id: I03aecfd1544b559a8fbd1ab11c5474145cff9ff9

tags: added: office-hours
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/474543
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=1baf3e65232183e8162eb46c28a4fa7708ff3509
Submitter: Jenkins
Branch: master

commit 1baf3e65232183e8162eb46c28a4fa7708ff3509
Author: Samriddhi Jain <email address hidden>
Date: Thu Jun 15 10:53:10 2017 +0530

    Added configuration references to documentation

    Currently some of the config references docs are a part of
    general OpenStack-manuals. Migrating those docs to keystone
    documentation so that they can be reviewed effectively by
    keystone developers too.

    Following the specs, the files are added to admin/ and
    configuration/ directories.

    The files containing congiguration options are added
    in a subsequent patch using oslo.config plugin.

    Partial-Bug #1694460

    Change-Id: I9a85f610e66a10dac54c50b2a54305e979888ee5

Changed in keystone:
milestone: pike-3 → pike-rc1
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to keystone (master)

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

Changed in keystone:
assignee: Samriddhi (s-jain) → Lance Bragstad (lbragstad)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

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

Reviewed: https://review.openstack.org/489755
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=429e115686acd1723423674a5f2e1c79ce8e5225
Submitter: Jenkins
Branch: master

commit 429e115686acd1723423674a5f2e1c79ce8e5225
Author: Lance Bragstad <email address hidden>
Date: Tue Aug 1 21:10:52 2017 +0000

    Add contributor/ directory for docs

    The specification detailing the great documentation migration
    requires a doc/source/contributor/ directory for all contributor
    documentation. Keystone had a directory specifically for this type
    of content but it was in doc/source/devref/.

    This commit renames devref/ to contributor/ because the term
    `contributor` is more inclusive of other community members that
    aren't necessarily developers. The specification also requires this
    convention for consistency with other projects.

    Change-Id: Id6363213dc6ba6946bd272ca5ee67b4604afc5ac
    Partial-Bug: 1694460

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/489756
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=900a00e4b4e3670ffe933ad3dadd8f933b6ef38a
Submitter: Jenkins
Branch: master

commit 900a00e4b4e3670ffe933ad3dadd8f933b6ef38a
Author: Lance Bragstad <email address hidden>
Date: Tue Aug 1 21:29:22 2017 +0000

    Add user/ directory for documentation

    The specification detailing the great documentation migration
    requires a doc/source/user/ directory be added to the project.
    The directory is intended for end user documentation.

    This commit add the directory so that we are in compliance with the
    specification but doesn't move any content into the directory. It is
    instead treated like a placeholder until we can migrate the right
    content into the user guide.

    Change-Id: I7d9cde958957bff20c7221f37cb0b03b61aa38f9
    Partial-Bug: 1694460

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

Reviewed: https://review.openstack.org/489757
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=bd5edb624707a6992224cc4ffc7b0d106386ecc6
Submitter: Jenkins
Branch: master

commit bd5edb624707a6992224cc4ffc7b0d106386ecc6
Author: Lance Bragstad <email address hidden>
Date: Tue Aug 1 21:34:17 2017 +0000

    Add cli/ directory for documentation

    The specification detailing the great documentation migration
    requires a doc/source/cli/ directory be added to the project.
    The directory is intended for cli documentation.

    This commit add the directory so that we are in compliance with the
    specification but doesn't move any content into the directory. It is
    instead treated like a placeholder until we can migrate the right
    content into the cli guide.

    Change-Id: Ida5ffc979d3c596547e9664dce8933d2cf9a4486
    Closes-Bug: 1694460

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/keystone 12.0.0.0rc1

This issue was fixed in the openstack/keystone 12.0.0.0rc1 release candidate.

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.