sec-guide section id names should be readable

[Bryan D. Payne]

In the security guide today, the section id names are the chapter name with a random id number on the end. This is harder to work with and not really necessary. To clean this up, we should change the id names to be the actual section name.

For example, case-studies-system-documentation-idp44480 should be case-studies-system-documentation-section-name-here.

This will require changing the ids at the section definitions throughout, and also changing any references to those names.

[Priti Desai (priti-desai)]

"case-studies-system-documentation-idp44480" could be named "case-studies-system-documentation-alice-private-cloud" but it adds almost 10 characters to section ID.

OR

we could remove the part with "case-studies" as its redundant with section titles, for example, "case-studies-system-documentation-idp44480" could be named "system-documentation-alice-private-cloud". I prefer this option.

Thoughts?

[Bryan D. Payne (bdpayne)]

While longer, I prefer the first approach. This is because I'm concerned about just the section name being globally unique throughout the document.

[Priti Desai (priti-desai)]

Sounds good, lets go with the first approach. Taking it up.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/119889
Committed: https://git.openstack.org/cgit/openstack/security-doc/commit/?id=b950fd4532e54f89029c5d645c1f0cdf0cc55c37
Submitter: Jenkins
Branch: master

commit b950fd4532e54f89029c5d645c1f0cdf0cc55c37
Author: Priti Desai <email address hidden>
Date: Mon Sep 8 12:27:42 2014 -0700

    Making section id names readable in security guide

    In the security guide, the section id names are the chapter name
    with a random id number on the end. This is harder to work with and not
    really necessary, for example,
    case-studies-system-documentation-idp44480. Replacing section id names with
    "case-studies-system-documentation-alice-private-cloud".

    Changing the ids at the section definitions for case studies throughout.
    No references are made to these section ids within security guide and
    hence no changes needed there.

    Partial-Bug: #1340388

    Change-Id: Ibaccd164332239dc9d701a74f5b84c2fd357feb6

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/123029
Committed: https://git.openstack.org/cgit/openstack/security-doc/commit/?id=1902f0044176857d3028852c2b8bc441d5e7b8c7
Submitter: Jenkins
Branch: master

commit 1902f0044176857d3028852c2b8bc441d5e7b8c7
Author: Priti Desai <email address hidden>
Date: Sun Sep 21 18:39:20 2014 -0700

    Making section id names readable in security guide

    In the security guide, the section id names are the chapter name
    with a random id number on the end. This is harder to work with and not
    really necessary. Replacing random id number with actual section names.

    Changing the ids at the section definitions for all the sections throughout.
    References to these ids are also updated.

    Change-Id: Id4aa5df8c7c025ae7a812f1b031041b14002c030
    Closes-bug: #1340388