Add introduction to chapters

Bug #1349555 reported by Andreas Jaeger
14
This bug affects 2 people
Affects Status Importance Assigned to Milestone
openstack-manuals
Fix Released
Medium
N Dillon

Bug Description

With https://review.openstack.org/#/c/110084/, we now have several chapters merged and thus often miss a nice introduction to a chapter. https://review.openstack.org/#/c/110114/ addresses a few chapters but not all.

We should have for each chapter at least a paragraph that describes the content of the chapter - and have this before the first section starts.

Tags: sec-guide
tags: added: sec-guide
Bryan D. Payne (bdpayne)
Changed in openstack-manuals:
status: New → Confirmed
importance: Undecided → Medium
N Dillon (sicarie)
Changed in openstack-manuals:
assignee: nobody → N Dillon (sicarie)
Revision history for this message
N Dillon (sicarie) wrote :

The following currently have introductory sections and do not need to be updated:
- Management
- Object Storage
- Networking
- Message queueing

The following do not have introductory sections and need to have them created:
- Introduction
- Secure Communication (can take some material from first 'Intro to TLS' section, but will most likely need to create some intro material)
- API endpoints (does have a single sentence, but needs more)

The following can have the first section of the first 'section_' file moved up to the 'ch_' file:
- System documentation (first paragraph)
- Data processing (most of the first paragraph and the 'in this chapter....' sentence)
- Databases (first 2 paragraphs)
- Tenant data privacy (first paragraph)
- Hypervisor and virtualization layer (first paragraph up, could add more to it as well)
- Instance security mgmt (first 3 paragraphs and list)
- Monitoring and logging (first two for sure, possibly first six)
- Compliance (first paragraph through list)

The following seem to have all data chunked together (possibly in the 'ch_' file and need to be split into 'section_' files but I have not validated yet):
- Identity
- Dashboard
- Compute
- Object storage (where S needs to be lowercase)

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

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

Changed in openstack-manuals:
status: Confirmed → In Progress
Revision history for this message
N Dillon (sicarie) wrote :

Pushed an initial test on this, going to wait for it to merge and render before I go through and do a bunch more

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

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

commit 248f4b4869db7d3c688a3d08fd1b007444870c4c
Author: dillonn <email address hidden>
Date: Tue Mar 10 12:01:49 2015 -0700

    Moving System documentation intro 'up' to chapter file

    Change-Id: I7298b5f3270949c196d0a5ec0ffaf2ff9d7165d0
    Partial-Bug: #1349555

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

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

Revision history for this message
N Dillon (sicarie) wrote :

Validated the following chapters all have most of the content in the ch_* file, and will be refactored:
- Identity
- Dashboard
- Compute
- Object storage

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

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

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

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

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

Change abandoned by Nathaniel Dillon (<email address hidden>) on branch: master
Review: https://review.openstack.org/164883
Reason: Cannot figure out where the errors are in the build; just submitted a single file successfully (ch_introductions) so will try it with api-endpoints and secure_communication as well.

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

Change abandoned by Nathaniel Dillon (<email address hidden>) on branch: master
Review: https://review.openstack.org/166045
Reason: Intro section merged through https://review.openstack.org/#/c/164883/

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

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

commit a04276653c5e535ebc39e41a5ab5ffc3ee279e02
Author: Nathaniel Dillon <email address hidden>
Date: Sun Mar 15 10:33:58 2015 -0700

    Moving introduction sections 'up' from section_* files to ch_* files

    Modified:
    - Dabases - moved first paragraph up
    - Tenant Privacy - moved first paragraph and list up
    - Hypervisor - moved first two paragraphs up
    - Instance Management - moved first three paragraphs and list up
    - Monitoring & Logging - moved first and third paragraphs up
    - Compliance - moved first paragraph and list up
    - Removing '<para/>' from section_compliance* line 70
    - Moved all text above section references

    Change-Id: I4dbb6bc51154ecaf44137cbaff0487930084cfe6
    Partial-Bug: #1349555

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

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

N Dillon (sicarie)
Changed in openstack-manuals:
milestone: none → liberty
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to security-doc (master)

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

commit d0d2be073b7dd75c8c0de02371608cba2845e990
Author: Nathaniel Dillon <email address hidden>
Date: Mon Mar 16 15:03:26 2015 -0700

    Adding new introudctions for chapters missing one

    Added Introduction section in ch_ file of the following:
    - Introduction
    - Secure communication
    - API endpoints
    - Refactoring to put all text before the section includes
    - Fixing typos in intro and case/typo in secure communication

    Change-Id: I409712313d8a420ce979023d985bf71fa5d739ce
    Partial-Bug: #1349555

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

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

commit d669764c29dfd8b23171a18f558252ebab0d745e
Author: dillonn <email address hidden>
Date: Tue Mar 24 08:53:25 2015 -0700

    Moving Data processing intro up to chapter file, and touching up section

    Change-Id: I4ec1c182ebd0c491262d32298d3ff1f5cf04f830
    Closes-Bug: #1349555

Changed in openstack-manuals:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.