OpenStack Security Guide - Convert to RST format

Bug #1463111 reported by N Dillon on 2015-06-08
14
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-manuals
High
Unassigned

Bug Description

-----------------------------------
Built: 2015-06-08T08:17:44 00:00
git SHA: 3d03c337bdc225d26271656daab2caa2161b91bf
URL: http://docs.openstack.org/security-guide/content/
source File: file:/home/jenkins/workspace/security-doc-tox-doc-publishdocs/security-guide/bk-openstack-security-guide.xml
xml:id: os-security-guide

Andreas Jaeger (jaegerandi) wrote :

Let's discuss this first on the openstack-docs mailing list, could you start an email thread, please?

N Dillon (sicarie) on 2015-06-08
Changed in openstack-manuals:
importance: Undecided → High
status: New → Triaged
N Dillon (sicarie) wrote :

Migration overview is here: https://wiki.openstack.org/wiki/Documentation/Migrate

It looks like the next step is to write a spec and start thinking about the staging. Some example specs are:

https://blueprints.launchpad.net/openstack-manuals/+spec/improve-ha-guide
https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration

N Dillon (sicarie) wrote :

A note for when we get going: #info If a common file is in the toc of one guide, consider moving it into the source file for that guide to prevent build errors

N Dillon (sicarie) wrote :

To use the :orphan: directive is the easiest workaround

Priti Desai (priti-desai) wrote :

I think we need to address these questions/points in the blueprint:

* We don’t have git repo to create BP, we might have to create one first (security-specs) or utilize doc-specs.
* Adding a new repo to hold rst files along with docbook: https://github.com/openstack/security-doc/tree/master/security-guide-rst
* First, create a RST infrastructure under security-guide-rst, similar to admin-guide-cloud-rst
* Create a list of chapters/sections which needs to be converted into RST and assign them to folks.

Priti Desai (priti-desai) wrote :

Maintaining notes here for this effort:

https://etherpad.openstack.org/p/sec-guide-rst

N Dillon (sicarie) wrote :

* Action to Nathaniel to determine where the blueprint should land
* Action to Priti to create security-guide-rst repo

N Dillon (sicarie) wrote :

Review for adding a security-specs repo that this will be submitted to:

https://review.openstack.org/#/c/196165/

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

Changed in openstack-manuals:
assignee: nobody → N Dillon (sicarie)
status: Triaged → In Progress

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

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

Changed in openstack-manuals:
assignee: N Dillon (sicarie) → Andreas Jaeger (jaegerandi)
Changed in openstack-manuals:
assignee: Andreas Jaeger (jaegerandi) → N Dillon (sicarie)
Changed in openstack-manuals:
assignee: N Dillon (sicarie) → Michael McCune (mimccune)
Changed in openstack-manuals:
assignee: Michael McCune (mimccune) → N Dillon (sicarie)

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

commit 9843d36e4087280b09959bc4549393f0007a4a2d
Author: Nathaniel Dillon <email address hidden>
Date: Mon Jul 20 21:26:24 2015 -0700

    Updating Compute chapter to RST

    + Concatenated all Compute chapter sections into one file
    + Broke all files out
    + Stripped DocBook formatting
    + Added RST formatting
    + Updated formatting
    + Added diagram fo figures/
    + Updating line lengths and file reference

    Change-Id: Ib9409f9df3da1bd1a6fc1d5780d327b671969faa
    Partial-Bug: #1463111

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

commit 9d986582708cf30495ffd937aab8372bf0727d2c
Author: Nathaniel Dillon <email address hidden>
Date: Mon Jul 20 18:09:27 2015 -0700

    Converting API endpoints section to RST

    + Concatenated ch_api, and two section_api files into one file
    + And broke them out again
    + Stripped DocBook markup and added RST markup
    + Trying to fix niceness around code tags
    + Cleaning up formatting and removing lingering docbook tags

    Change-Id: I79a22c2474e253e329dd68b8b8ae9eea9e53b911
    Partial-Bug: #1463111

Changed in openstack-manuals:
assignee: N Dillon (sicarie) → Priti Desai (priti-desai)

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

commit a0bf08375df79c22f166aa79d6bae8cfffd0676b
Author: Nathaniel Dillon <email address hidden>
Date: Mon Jul 20 23:01:02 2015 -0700

    Updating Documentation section from DocBook to RST

    + Concatenated ch, section, and case study file into one
    + Stripped DocBook tags
    + Added RST tags
    + Added image tag for picture
    + Separated back into 3 files
    + Added documentation folder and files
    + Added figures and updated case-studies.rst filename
    + Updated case-studies filename and command to config

    Change-Id: I0a8c4f8de7899b43db248accb1f0e4dde78b5b7f
    Partial-Bug: #1463111

Changed in openstack-manuals:
status: In Progress → Confirmed
status: Confirmed → In Progress
status: In Progress → Fix Committed
assignee: Priti Desai (priti-desai) → deng.zhengyi (deng-zhengyi)
status: Fix Committed → Confirmed
Changed in openstack-manuals:
status: Confirmed → In Progress
status: In Progress → Confirmed
assignee: deng.zhengyi (deng-zhengyi) → nobody
assignee: nobody → deng.zhengyi (deng-zhengyi)
assignee: deng.zhengyi (deng-zhengyi) → nobody
Andreas Jaeger (jaegerandi) wrote :

Finished

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

Other bug subscribers