Security Guide Should Group Related Chapters

[Bryan D. Payne]

The security guide has groupings of chapters that go together (such as TLS, message queues, databases, etc). Right now these are just all listed as discrete chapters without any sense of their logical grouping (both within the ToC and within the inside of the book). The book would flow better and be more readable if we could highlight these groups of chapters better.

[Andreas Jaeger (jaegerandi)]

You could use sections instead of chapters for some of these. Especially the use cases I suggest to do as sections.

<part> is also a way to group related chapters.

[Bryan D. Payne (bdpayne)]

You thinking to basically just combine some of the existing chapters? And then those existing chapters could become sections? That's probably pretty reasonable given the current state of affairs.

[Andreas Jaeger (jaegerandi)]

Bryan, that would be my first step instead. For example: Make "7. Case studies: system documentation" a section of "6. System documentation requirements".

Compare it with the Install Guide - our "Validation section" is a section at the end of each chapter.

[Andreas Jaeger (jaegerandi)]

Or chapters 29, 30 and 31 about Messaging Queue - make them one chapter with three sections in it:
Chapter: Messaging Queue
Section: Architecture
Section: Security
Section: Case Study

The alternative would be to use parts - like the Operations Guide does. But the way the book is build you would end with more than 10 parts which is not reasonable.

[Bryan D. Payne (bdpayne)]

This makes sense, thanks for the feedback.

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

commit 4ff40b40cd17b747fc5152e1e5cc27d58f9f744d
Author: Andreas Jaeger <email address hidden>
Date: Fri Jul 25 21:38:32 2014 +0200

    Merge some chapters

    Merge omechapters by topic so that each chapter handles
    a topic completely including case studies.

    Change-Id: If1a465c556e3be3ae775e7c8a88bf5b413aa2de9
    Partial-Bug: #1341836

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

commit 8618dfe570218d6c2af813ba434d46bf6cbd4029
Author: Andreas Jaeger <email address hidden>
Date: Mon Jul 28 20:03:24 2014 +0200

    Merge further chapters

    Merge chapters by topic so that each chapter handles
    a topic completely including case studies.

    Change-Id: I54462993317d1c0cadb4cb29403bdd605ac6829a
    Partial-Bug: #1341836

[OpenStack Infra (hudson-openstack)]

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

commit 8cc0954d6c9ba721fbb1110b0b5a82245a026d71
Author: Andreas Jaeger <email address hidden>
Date: Mon Jul 28 21:44:41 2014 +0200

    Move some sections one level up

    Move some sections a level up so that the initial page of a chapter
    contains a nice introduction to the overall chapter.

    Change-Id: I7f5728923ff2361cddd4df40f8021866c0f06984
    Closes-Bug: #1341836