Apply document markup conventions to source XML files

[Anne Gentle]

We have DocBook markup conventions at https://wiki.openstack.org/wiki/Documentation/Conventions#DocBook_markup_conventions. Generally we try to follow them but a clean up would be welcomed.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/43763
Committed: http://github.com/openstack/openstack-manuals/commit/b97151503eaa85137aa93ff6ae3642e5f1090f4c
Submitter: Jenkins
Branch: master

commit b97151503eaa85137aa93ff6ae3642e5f1090f4c
Author: Andreas Jaeger <email address hidden>
Date: Mon Aug 26 21:38:58 2013 +0200

    Fix programlistings for common, user, config guides

    The goal is to use programlisting properly and thus I added proper
    language setting as appropriate and also used userinput in a few cases

    Partial-Bug: #1217503

    Change-Id: Ib38273845b165a0f66ea23f3bf681aa2d8712e00

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/44344
Committed: http://github.com/openstack/openstack-manuals/commit/e9c441fe2e5e012b5541c1d84175ea416756404e
Submitter: Jenkins
Branch: master

commit e9c441fe2e5e012b5541c1d84175ea416756404e
Author: Andreas Jaeger <email address hidden>
Date: Thu Aug 29 20:45:25 2013 +0200

    Follow conventions in Config Guide

    Mainly programlistings update and using filename instead of literal.

    Change-Id: I99aea87b0229e13a6e4f25b5d036032b3af5f2a9
    Partial-Bug: #1217503

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/44764
Committed: http://github.com/openstack/openstack-manuals/commit/9a5800ff9088158eda8f05c0bedf715673579034
Submitter: Jenkins
Branch: master

commit 9a5800ff9088158eda8f05c0bedf715673579034
Author: Andreas Jaeger <email address hidden>
Date: Mon Sep 2 22:28:38 2013 +0200

    Some editorial cleanup for openstack-config/block-storage

    Change-Id: I3cbca313f4eac1e338d69daf700e8b3910b98472
    Partial-Bug: #1217503

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/46631
Committed: http://github.com/openstack/openstack-manuals/commit/34a567089bedcb6af40717d10d4c430fae111fbf
Submitter: Jenkins
Branch: master

commit 34a567089bedcb6af40717d10d4c430fae111fbf
Author: Andreas Jaeger <email address hidden>
Date: Sat Sep 14 20:28:53 2013 +0200

    Fix markup

    This fixes mainly screens, computeroutput/userinput and also
    marks some filenames. A lot of prompts have been added.

    Change-Id: I864dc5b051bb297b61c9b2ed5464f9a35306bd68
    Partial-Bug: #1217503

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/67016
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=12e13afa645e0a7ad64b3ad77046845dffc17880
Submitter: Jenkins
Branch: master

commit 12e13afa645e0a7ad64b3ad77046845dffc17880
Author: Don Domingo <email address hidden>
Date: Thu Jan 16 16:04:58 2014 +1000

    Applied correct tag "<parameter>" in two instances.

    Change-Id: I2b7e21ac5238a71ac8aaceed92f72796e9e1f418
    Partial-bug: 1217503

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/67747
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=3e1100a70af091370d9a1f95cd260b754af88938
Submitter: Jenkins
Branch: master

commit 3e1100a70af091370d9a1f95cd260b754af88938
Author: Don Domingo <email address hidden>
Date: Mon Jan 20 11:29:26 2014 +1000

    Applied conventions for "e.g."

    As per convention, we should avoid using "e.g." (we should use "for
    example" instead). Found and replaced them accordingly; didn't touch
    instances that looked copy-pasted from stdout.

    Change-Id: I45aae1a30b872f916744a6a33f6888abe8cf6eb0
    Partial-Bug: #1217503

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/68733
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=8bc857086e01135aa5ca07092f316e2b486f8b00
Submitter: Jenkins
Branch: master

commit 8bc857086e01135aa5ca07092f316e2b486f8b00
Author: Laurel Michaels <email address hidden>
Date: Thu Jan 23 14:22:48 2014 -0500

    improved readability and markup

    Removed whitespace

    Added markup per conventions

    Change-Id: I5808872930806c7bde90564d5fade0d5486083fb
    Partial-Bug: #1217503

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/70040
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=486de8c5aa2d2c8ced926fd42b8c3025380ea6f0
Submitter: Jenkins
Branch: master

commit 486de8c5aa2d2c8ced926fd42b8c3025380ea6f0
Author: Martin Lopes <email address hidden>
Date: Thu Jan 30 11:46:44 2014 +1000

    Revised wording regarding HA capabilites

    Text originally stated that HA prevents node failures, which may result
    in a mismatch with user expectations. Revised statement to clarify that
    HA helps mitigate the impact of individual node failures.

    Change-Id: I805a642ee6020ca53c27c120a811ca7349a2f14f
    Partial-Bug: #1217503

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/70063
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=1fff455519112615f5b3f7ef9586a3b33041425b
Submitter: Jenkins
Branch: master

commit 1fff455519112615f5b3f7ef9586a3b33041425b
Author: Martin Lopes <email address hidden>
Date: Thu Jan 30 16:18:27 2014 +1000

    Edited terminology for hypervisor support in Compute

    The word "type" has a specific application when used in reference to
    hypervisor technology. The bulleted list that follows could be
    considered a variety of bare metal hypervisors rather than
    virtualization standards.

    Change-Id: I0bd35b3f18731c5c5b7c7a35abae999cf937acf9
    Partial-Bug: #1217503

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/70293
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=bdeaeade1cd7bfef2bb075b81d831cb9f48929b9
Submitter: Jenkins
Branch: master

commit bdeaeade1cd7bfef2bb075b81d831cb9f48929b9
Author: Martin Lopes <email address hidden>
Date: Fri Jan 31 14:41:28 2014 +1000

    Minor edit of wording regarding Networking clusters

    Text originally stated that Networking services can be run into a
    cluster. Revised to clarify that these services can be run in a
    cluster configuration.

    Change-Id: Ied66ecde223537e5e1e7b0f33dd4e86dcde07379
    Partial-Bug: #1217503

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/71826
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=94a0f25c3736c8ea1d141554078fc94271ba8dfe
Submitter: Jenkins
Branch: master

commit 94a0f25c3736c8ea1d141554078fc94271ba8dfe
Author: Martin Lopes <email address hidden>
Date: Fri Feb 7 18:49:52 2014 +1000

    Updates ML2 content in Networking intro

    Rewrote introductory ML2 text for clarity. Made special mention of
    the use case where ML2 will offer particular benefit. Updated the
    note to emphasize that the deprecated plug-ins have been ported to
    ML2.

    Change-Id: Ie9273c73b265d6afe9a3603348c59806c1a9561c
    Partial-Bug: #1217503

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/72635
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=2ab34e9c4a2d8dfd34e63af5550d7a85ac4f235c
Submitter: Jenkins
Branch: master

commit 2ab34e9c4a2d8dfd34e63af5550d7a85ac4f235c
Author: Martin Lopes <email address hidden>
Date: Tue Feb 11 22:23:33 2014 +1000

    Applies conventions to Networking Use section

    Edits for punctuation and service name conventions where appropriate.
    Rewords a number of sentences.

    Change-Id: I13e06c13c4cd5446a1f4073b6dcefee0aa475ee0
    Partial-Bug: #1217503

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/72645
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=824e8a6c795478c5e3e81c073e6b0fce172d76f1
Submitter: Jenkins
Branch: master

commit 824e8a6c795478c5e3e81c073e6b0fce172d76f1
Author: Martin Lopes <email address hidden>
Date: Tue Feb 11 23:06:17 2014 +1000

    Applies conventions to Networking Scenarios section

    Edits for punctuation and service name conventions where appropriate.
    Rewords a number of sentences.

    Change-Id: I49ead9108fd4633754368296f717db49b81bfb8e
    Partial-Bug: #1217503

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/75666
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=caf4a98f606e16fbfea146aeeb2872bc6e3d38c5
Submitter: Jenkins
Branch: master

commit caf4a98f606e16fbfea146aeeb2872bc6e3d38c5
Author: Martin Lopes <email address hidden>
Date: Sun Feb 23 17:21:25 2014 +1000

    Rewords Networking architecture section

    Rewords language to distinguish between process, services and
    components. Updates some technical terminology. Various other small
    changes throughout.

    Change-Id: I6d39b7707a0971251974d41636415d73a18b7bf7
    Partial-Bug: #1217503

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/81163
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=20f780cd61b1b50ad34fea936e95b9699f9b5db5
Submitter: Jenkins
Branch: master

commit 20f780cd61b1b50ad34fea936e95b9699f9b5db5
Author: Don Domingo <email address hidden>
Date: Tue Mar 18 13:49:32 2014 +1000

    Apply service name conventions for Compute

    There are several instances of "Compute Service" and "compute service"
    in the upstream documentation. As was recently clarified in the docs
    mailing list, these should be "Compute service/s". This patch corrects
    all untagged instances inside normal <para> blocks.

    Change-Id: Idcd7aafa0ce463e70635cb1c883a2476c1d97b5e
    Partial-Bug: #1217503

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/81422
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=5fca287eb58d87419ff0d179b81df702c9cf33b4
Submitter: Jenkins
Branch: master

commit 5fca287eb58d87419ff0d179b81df702c9cf33b4
Author: Don Domingo <email address hidden>
Date: Wed Mar 19 13:07:11 2014 +1000

    Apply service name conventions for Block Storage

    There are several instances of "Block Storage Service" in the
    upstream documentation. As was recently clarified in the docs
    mailing list, these should be "Block Storage service". This patch
    applies the fix.

    Change-Id: I591c100ab031b75f1c0d27d45f53e32401a26e30
    Partial-Bug: #1217503

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/81423
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=98e7068e488c519fcd57d58a21dab9171c846e14
Submitter: Jenkins
Branch: master

commit 98e7068e488c519fcd57d58a21dab9171c846e14
Author: Don Domingo <email address hidden>
Date: Wed Mar 19 13:30:24 2014 +1000

    Apply service name conventions for Image Service

    There are several instances of "Image service" in the upstream
    documentation. As was recently clarified in the docs mailing list,
    these should be "Image Service". This patch applies the fix.

    Change-Id: Iefb63673162ae97b2c0fe1c3ff3fb1ac05e95d83
    Partial-Bug: #1217503

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/84042
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=16b8a5616000d7f506f4a855b28b683ea1120d6f
Submitter: Jenkins
Branch: master

commit 16b8a5616000d7f506f4a855b28b683ea1120d6f
Author: Summer Long <email address hidden>
Date: Mon Mar 31 12:35:56 2014 +1000

    Edited Ceph driver section.

    Removed outdated link (refers to nova volume which is no longer used), and edited the section. Updated note about Btrfs and included new link.

    Partial-Bug: #1217503

    Change-Id: I6fa0c013a138dfca4ab37f5df68e55eeb3a4c150

[OpenStack Infra (hudson-openstack)]

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

[Openstack Gerrit (openstack-gerrit)]

Reviewed: https://review.openstack.org/91779
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=c31d6c463f73f9296dc0cd8d2cfbb23e0ddae5f5
Submitter: Jenkins
Branch: master

commit c31d6c463f73f9296dc0cd8d2cfbb23e0ddae5f5
Author: Andreas Jaeger <email address hidden>
Date: Fri May 2 15:10:50 2014 +0200

    Fix screen usage in Security Guide

    Cleanup usage of screens:
    * Replace with programlistings where appropriate
    * Add prompts

    Also, fix some filename markup.

    Partial-Bug: #1217503

    Change-Id: I0b9b8a73d3449bd33cf7348b49cdc1d02f203c4f

[Openstack Gerrit (openstack-gerrit)]

Reviewed: https://review.openstack.org/92197
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=6bf4dedafc8f9a575180ae8de8d41bea6c48503e
Submitter: Jenkins
Branch: master

commit 6bf4dedafc8f9a575180ae8de8d41bea6c48503e
Author: Andreas Jaeger <email address hidden>
Date: Mon May 5 21:32:29 2014 +0200

    Edits on security guide

    Change all titles to sentence style capitalization (some were already,
    majority not)
    Adjust project and service name spelling.
    Minor edits
    Fix links to TPM section

    Change-Id: Ic8cc709b068d2273762f074daa5ac30ebe9aaf20
    Partial-Bug: #1217503

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/92648
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=2dad59797db28c396a7e599390ba965cdfc62072
Submitter: Jenkins
Branch: master

commit 2dad59797db28c396a7e599390ba965cdfc62072
Author: Andreas Jaeger <email address hidden>
Date: Wed May 7 20:03:08 2014 +0200

    Security guide editorial edits

    No textual changes, just markup and style, mainly:
    * Add missing <filename> markup
    * Change capitalization
    * Wrap some overly long lines
    * Remove extra whitespace before ":"
    * Replace "--" with emdash

    Change-Id: I9126a91c5d1f78feacb10c639b26f37fc6815a99
    Partial-Bug: #1217503

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/93241
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=c4aa170efa774bb61576c5b7b01fc567c290f3c5
Submitter: Jenkins
Branch: master

commit c4aa170efa774bb61576c5b7b01fc567c290f3c5
Author: Andreas Jaeger <email address hidden>
Date: Sun May 11 21:21:32 2014 +0200

    Apply conventions for Swift and Ceilometer

    Use "swift" instead of "Swift".
    Use "Telemetry" instead of "Ceilometer" where appropriate, lowercase
    "ceilometer" as project name.
    Reformat file common/section_objectstorage-features.xml.
    Add some systemitem markup.

    Partial-Bug: #1217503

    Change-Id: Ia56a245a4993e4ea92fe19f38af443cf1bc411f5

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/93237
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=18be804cdbb257afcddd372c47fd96d98277ee1f
Submitter: Jenkins
Branch: master

commit 18be804cdbb257afcddd372c47fd96d98277ee1f
Author: Andreas Jaeger <email address hidden>
Date: Sun May 11 15:43:07 2014 +0200

    Better follow conventions in HA Guide

    Follow our conventions for title capitalization and usage of
    project/service names.

    Follow conventions on using active voice, no -ing for titles.

    Co-Authored-By: Diane Fleming <email address hidden>

    Change-Id: I05e368f8dda436454d2daca1a6775105032a39fc
    Partial-Bug: #1217503

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/105263
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=896d83a04fc85a3af261fccdf88c158ffe18d0d9
Submitter: Jenkins
Branch: master

commit 896d83a04fc85a3af261fccdf88c158ffe18d0d9
Author: Andreas Jaeger <email address hidden>
Date: Mon Jul 7 20:53:11 2014 +0200

    Cleanup HA Guide

    Cleanup HA Guide to better follow our XML conventions and practices:
    * Change simpara to para. We do not use simpare in our guides.
    * Remove <info> around titles, this is not really needed and not done in
      other guides.
    * Change <xi:include href="./file.xml" to <xi:include href="file.xml"
    * Fix usage of screen
    * Remove unneeded link xmlns:xlink="http://www.w3.org/1999/xlink"
      declarations.
    * Remove space before ":"

    Partial-Bug: #1217503

    Change-Id: Ie90a7c60be4646a95b7d8aec88773d199fc1a1b2

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/141266
Committed: https://git.openstack.org/cgit/openstack/operations-guide/commit/?id=778717510c61bcff3b5ffb33eaa864e786175778
Submitter: Jenkins
Branch: master

commit 778717510c61bcff3b5ffb33eaa864e786175778
Author: darrenchan <email address hidden>
Date: Fri Dec 12 15:06:13 2014 +1100

    Edits to the upgrade section in the Operations Guide

    Restructured content in the Havana to Icehouse upgrade for
    Ubuntu sections

    Change-Id: I849fbb49e0730f6d78a1f20d93f077b23d006903
    backport: icehouse
    Partial-bug: #1217503

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/143598
Committed: https://git.openstack.org/cgit/openstack/operations-guide/commit/?id=e7abe7f990d0bb43bd4c5c8abe4fdbf218792a41
Submitter: Jenkins
Branch: master

commit e7abe7f990d0bb43bd4c5c8abe4fdbf218792a41
Author: darrenchan <email address hidden>
Date: Tue Dec 23 16:31:05 2014 +1100

    Restructured upgrade sections in the Operations Guide

    Restructured content in the Havana to Icehouse upgrade for
    RHEL sections

    Change-Id: I57b4ce31baa5ade5bbf22b5353327ad8d1587112
    backport: none
    Partial-Bug: #1217503

[Christian Berendt (berendt)]

Do we still need this bug report for tracking purposes? I think it can be closed.

[Anne Gentle (annegentle)]

We've used this bug for onboarding purposes, to train new writers on the "code base." Does get pretty long though! I would like to keep it if possible. People will still need to markup RST.

[Lana (loquacity)]

I think we can probably suggest new hires find and fix errors in the new contributor guide, now, so this bug can be retired.