openstack-manuals: rename subfolders to use naming convention

[Diane Fleming]

The folders in the openstack-manuals repo are oddly named. First off, they really don't require an "openstack" prefix because they are in the openstack-manuals repo.

I will remove the parent folders doc/src/docbkx from the child book folders.

I will also remove the "src" subdir in those book folders that have them.

Finally, the book folders don't follow a naming convention.

I plan to rename them by using the following naming convention:

<book-type>-<project>
or
<book-type>-<audience>

basic-install
-> install-guide-basic
cli-guide (going away)
common
NEW
-> admin-guide-cloud (Cloud Administrators Guide) new comprehensive admin guide (the cloud part just so we know it's the comprehensive guide)
docbkx-example
openstack-block-storage-admin
-> becomes a chapter in the new admin-guide-cloud
openstack-compute-admin
-> becomes a chapter in admin-guide-cloud
openstack-config
-> config-reference
openstack-ha
-> high-availability-guide
openstack-image
-> image-guide
openstack-install
-> install-guide
openstack-network-connectivity-admin
-> admin-guide-network – must remain a separate guide (for now)
openstack-object-storage-admin
-> becomes a chapter in admin-guide-cloud
openstack-security
-> security-guide
openstack-training
-> training-guide
openstack-user
-> user-guide
openstack-user-admin
-> user-guide-admin

[Anne Gentle (annegentle)]

I think this'll help much with walk-up contributors, thanks.

[Nermina Miller (nerminamiller)]

Indeed!

On Tue, Sep 3, 2013 at 3:57 PM, Anne Gentle <email address hidden> wrote:

> I think this'll help much with walk-up contributors, thanks.
>
> --
> You received this bug notification because you are subscribed to
> openstack-manuals havana.
> Matching subscriptions: havana
> https://bugs.launchpad.net/bugs/1220407
>
> Title:
> openstack-manuals: rename subfolder to use naming convention
>
> Status in OpenStack Manuals:
> Confirmed
>
> Bug description:
> The folders in the openstack-manuals repo are oddly named. First off,
> they really don't require an "openstack" prefix because they are in
> the openstack-manuals repo.
>
> Secondly, they don't follow a naming convention.
>
> I plan to rename them by using the following naming convention:
>
> <book-type>-<project>
> or
> <book-type>-<audience>
>
>
> basic-install
> -> install-guide-basic
> cli-guide (going away)
> common
> NEW
> -> admin-guide-cloud (Cloud Administrators Guide) new comprehensive
> admin guide (the cloud part just so we know it's the comprehensive guide)
> docbkx-example
> openstack-block-storage-admin
> -> becomes a chapter in the new admin-guide-cloud
> openstack-compute-admin
> -> becomes a chapter in admin-guide-cloud
> openstack-config
> -> config-reference
> openstack-ha
> -> high-availability-guide
> openstack-image
> -> image-guide
> openstack-install
> -> install-guide
> openstack-network-connectivity-admin
> -> admin-guide-network – must remain a separate guide (for now)
> openstack-object-storage-admin
> -> becomes a chapter in admin-guide-cloud
> openstack-security
> -> security-guide
> openstack-training
> -> training-guide
> openstack-user
> -> user-guide
> openstack-user-admin
> -> user-guide-admin
>
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/openstack-manuals/+bug/1220407/+subscriptions
>

--
Thank you!

Nermina Miller
Tech Writer and Editor

[Sean Roberts (sarob)]

this looks like a good idea to me. thanks.

[Andreas Jaeger (jaegerandi)]

Diane, I like the idea - and propose to evaluate two more topics on top of it while we're doing major surgery.

I don't know the history of how docs came together but diving into the project, I had two additional structure issues:

First, why do we have doc/src/docbkx where doc and src have only a single directory? Can't we flatten this directly from doc/src/docbokx to doc?

Second, we have some guides that have a src subdirectory - and others have none. I propose to remove the current src subdirectories and move everything one level up. So, move openstack-user/src/* to openstack-user/

[Diane Fleming (diane-fleming)]

Andreas, I've addressed your issues in the bug. See the revised description.

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/45517
Committed: http://github.com/openstack/openstack-manuals/commit/64b6c9261ef1f29cba7f73bb73c6fed3a59fbea2
Submitter: Jenkins
Branch: master

commit 64b6c9261ef1f29cba7f73bb73c6fed3a59fbea2
Author: Diane Fleming <email address hidden>
Date: Fri Sep 6 23:40:23 2013 -0500

    Folder rename, file rename, flattening of directories

    Current folder name New folder name Book title
    ----------------------------------------------------------
    basic-install DELETE
    cli-guide DELETE
    common common
    NEW admin-guide-cloud Cloud Administrators Guide
    docbkx-example DELETE
    openstack-block-storage-admin DELETE
    openstack-compute-admin DELETE
    openstack-config config-reference OpenStack Configuration Reference
    openstack-ha high-availability-guide OpenStack High Availabilty Guide
    openstack-image image-guide OpenStack Virtual Machine Image Guide
    openstack-install install-guide OpenStack Installation Guide
    openstack-network-connectivity-admin admin-guide-network OpenStack Networking Administration Guide
    openstack-object-storage-admin DELETE
    openstack-security security-guide OpenStack Security Guide
    openstack-training training-guide OpenStack Training Guide
    openstack-user user-guide OpenStack End User Guide
    openstack-user-admin user-guide-admin OpenStack Admin User Guide
    glossary NEW OpenStack Glossary

    bug: #1220407

    Change-Id: Id5ffc774b966ba7b9a591743a877aa10ab3094c7
    author: diane fleming

[Dolph Mathews (dolph)]

The above change appears to have completely deleted openstack-compute-admin, even though the bug description says it "becomes a chapter in admin-guide-cloud." Is there supposed to be a follow-up patch to this?

[Tom Fifield (fifieldt)]

what particular content from openstack-compute-admin are you after? It's dispersed throughout the universe ...

[Brant Knudson (blk-u)]

The problem I'm having now is that when I generate the doccs for admin-guide-cloud, it's nothing like what's on http://docs.openstack.org/trunk/openstack-compute/admin/content/index.html . Trying to make updates, but it's hard to find where to make the change when the docs I generate locally don't look like what's on the published site.

[Tom Fifield (fifieldt)]

Bringing this to the attention of others - standby

[Anne Gentle (annegentle)]

Since the http://docs.openstack.org/trunk
/openstack-compute/admin/content/index.html URL is the most-visited page on
the site, we plan to redirect it as indicated in
https://docs.google.com/spreadsheet/ccc?key=0AhXvn1h0dcyYdGhtUTRhRkdvQzN0MEFrVnNsTk9pc0E#gid=0

However, the build for admin-guide-cloud is not yet working, sorry. Working
on it. https://bugs.launchpad.net/openstack-ci/+bug/1223065

On Mon, Sep 9, 2013 at 4:40 PM, Brant Knudson <email address hidden> wrote:

> The problem I'm having now is that when I generate the doccs for admin-
> guide-cloud, it's nothing like what's on http://docs.openstack.org/trunk
> /openstack-compute/admin/content/index.html . Trying to make updates,
> but it's hard to find where to make the change when the docs I generate
> locally don't look like what's on the published site.
>
> --
> You received this bug notification because you are a bug assignee.
> https://bugs.launchpad.net/bugs/1220407
>
> Title:
> openstack-manuals: rename subfolders to use naming convention
>
> Status in OpenStack Manuals:
> Fix Released
>
> Bug description:
> The folders in the openstack-manuals repo are oddly named. First off,
> they really don't require an "openstack" prefix because they are in
> the openstack-manuals repo.
>
> I will remove the parent folders doc/src/docbkx from the child book
> folders.
>
> I will also remove the "src" subdir in those book folders that have
> them.
>
> Finally, the book folders don't follow a naming convention.
>
> I plan to rename them by using the following naming convention:
>
> <book-type>-<project>
> or
> <book-type>-<audience>
>
> basic-install
> -> install-guide-basic
> cli-guide (going away)
> common
> NEW
> -> admin-guide-cloud (Cloud Administrators Guide) new comprehensive
> admin guide (the cloud part just so we know it's the comprehensive guide)
> docbkx-example
> openstack-block-storage-admin
> -> becomes a chapter in the new admin-guide-cloud
> openstack-compute-admin
> -> becomes a chapter in admin-guide-cloud
> openstack-config
> -> config-reference
> openstack-ha
> -> high-availability-guide
> openstack-image
> -> image-guide
> openstack-install
> -> install-guide
> openstack-network-connectivity-admin
> -> admin-guide-network – must remain a separate guide (for now)
> openstack-object-storage-admin
> -> becomes a chapter in admin-guide-cloud
> openstack-security
> -> security-guide
> openstack-training
> -> training-guide
> openstack-user
> -> user-guide
> openstack-user-admin
> -> user-guide-admin
>
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/openstack-manuals/+bug/1220407/+subscriptions
>