Apply doc conventions to service v. project names.

Bug #1121866 reported by Salvatore Orlando
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-api-site
Fix Released
Wishlist
Diane Fleming
openstack-manuals
Fix Released
Wishlist
chandan kumar

Bug Description

Apply doc conventions to service v. project names.

Based on http://wiki.openstack.org/Documentation/Conventions

Renames the book file and adjusts the pom.xml accordingly.

Various references to project names such as "Nova" "Keystone" and "Quantum" should be replace with
OpenStack Compute, Identity, Networking names where appropriate.

As of the current status I am sure we have plenty of references to quantum at least.

Anne Gentle (annegentle)
Changed in openstack-api-site:
status: New → Confirmed
Anne Gentle (annegentle)
tags: added: low-hanging-fruit
Revision history for this message
Anne Gentle (annegentle) wrote :

I think this is a nice ongoing bug to track, for newcomers and those wanting to get familiar with the tool chain and info architecture.

Jay_Clark (jay-clark)
Changed in openstack-manuals:
assignee: nobody → Jay_Clark (jay-clark)
Revision history for this message
Anne Gentle (annegentle) wrote :

In addition to the Conventions page, we also have a documentation checklist at https://wiki.openstack.org/wiki/Documentation/Checklist#Documentation_checklist.

Changed in openstack-manuals:
status: New → Confirmed
importance: Undecided → Medium
Tom Fifield (fifieldt)
Changed in openstack-api-site:
milestone: grizzly → none
assignee: Salvatore Orlando (salvatore-orlando) → nobody
Changed in openstack-manuals:
assignee: Jay_Clark (jay-clark) → nobody
Changed in openstack-api-site:
importance: High → Wishlist
Changed in openstack-manuals:
importance: Medium → Wishlist
Changed in openstack-api-site:
status: Confirmed → Triaged
Changed in openstack-manuals:
status: Confirmed → Triaged
Changed in openstack-manuals:
assignee: nobody → chandankumar (chandankumar-093047)
Revision history for this message
chandan kumar (chkumar246) wrote :

Hello Anne and Tom,
For this bug, we need to replace following things in the manuals:
Nova -> OpenStack Compute
Keystone -> OpenStack Identity
Quantum / Neutron -> OpenStack Networking
Glance -> OpenStack Image
Swift -> OpenStack Object Storage
Cinder -> OpenStack Block Strorage

Will i submit the review as per file wise or manual- wise?

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

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

Changed in openstack-manuals:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

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

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

Revision history for this message
Anne Gentle (annegentle) wrote :

Per manual is preferred.

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

Reviewed: https://review.openstack.org/58252
Committed: http://github.com/openstack/openstack-manuals/commit/92b0b6fd36cfa197a0819e7804fd20f659eecf17
Submitter: Jenkins
Branch: master

commit 92b0b6fd36cfa197a0819e7804fd20f659eecf17
Author: Chandan kumar <email address hidden>
Date: Mon Nov 25 16:38:28 2013 +0530

    Added Doc conventions to the remaining admin-guide-cloud chapters

    Change-Id: I6fc2f90b979fd4c8d45cfa223808c4a8f1eab8b9
    Partial-Bug: #1121866

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

Reviewed: https://review.openstack.org/58227
Committed: http://github.com/openstack/openstack-manuals/commit/91c10b86b86b0db34669480ee1ba2979342f95ad
Submitter: Jenkins
Branch: master

commit 91c10b86b86b0db34669480ee1ba2979342f95ad
Author: Chandan kumar <email address hidden>
Date: Mon Nov 25 14:49:48 2013 +0530

    Applied Doc conventions in Admin-guide-cloud-1

    Change-Id: I0e750bb49a9c2f7576fb8c7f957f2257bfcf52cb
    Partial-Bug: #1121866

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

Reviewed: https://review.openstack.org/58244
Committed: http://github.com/openstack/openstack-manuals/commit/8365bf6804c2699c8ec2fb8bdcc8383f5bfceef3
Submitter: Jenkins
Branch: master

commit 8365bf6804c2699c8ec2fb8bdcc8383f5bfceef3
Author: Chandan kumar <email address hidden>
Date: Mon Nov 25 15:47:20 2013 +0530

    Applied Doc conventions in Admin-guide-cloud-2

    Change-Id: Ia3c42cc8f851c0f50d8ff62710bc9c244be44e09
    Partial-Bug: #1121866

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

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

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

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

Changed in openstack-manuals:
assignee: chandankumar (chandankumar-093047) → Lana (loquacity)
Changed in openstack-manuals:
assignee: Lana (loquacity) → chandankumar (chandankumar-093047)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Changed in openstack-manuals:
assignee: chandankumar (chandankumar-093047) → Lana (loquacity)
assignee: Lana (loquacity) → chandankumar (chandankumar-093047)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

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

Reviewed: https://review.openstack.org/58929
Committed: http://github.com/openstack/openstack-manuals/commit/7ac18a94b82bdf9b09a4c90d01664ac29e2ad13b
Submitter: Jenkins
Branch: master

commit 7ac18a94b82bdf9b09a4c90d01664ac29e2ad13b
Author: Chandan kumar <email address hidden>
Date: Thu Nov 28 12:55:23 2013 +0530

    Added complete Doc Convention to config-reference guide.

    backport: havana

    Change-Id: I0936caed5cac45373df9bbc077f66bcfa2f96b58
    Partial-Bug: #1121866

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-manuals (stable/havana)

Fix proposed to branch: stable/havana
Review: https://review.openstack.org/59133

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-manuals (stable/havana)

Reviewed: https://review.openstack.org/59133
Committed: http://github.com/openstack/openstack-manuals/commit/eaf7f9c0d71a2747423df854af9a27653be5e46f
Submitter: Jenkins
Branch: stable/havana

commit eaf7f9c0d71a2747423df854af9a27653be5e46f
Author: Chandan kumar <email address hidden>
Date: Thu Nov 28 12:55:23 2013 +0530

    Added complete Doc Convention to config-reference guide.

    backport: havana

    Change-Id: I0936caed5cac45373df9bbc077f66bcfa2f96b58
    Partial-Bug: #1121866
    (cherry picked from commit 7ac18a94b82bdf9b09a4c90d01664ac29e2ad13b)

tags: added: in-stable-havana
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-manuals (master)

Reviewed: https://review.openstack.org/58678
Committed: http://github.com/openstack/openstack-manuals/commit/201f5c66390d8c614d1e487d2e57d36149efeb50
Submitter: Jenkins
Branch: master

commit 201f5c66390d8c614d1e487d2e57d36149efeb50
Author: Chandan kumar <email address hidden>
Date: Wed Nov 27 11:40:12 2013 +0530

    Added complete Doc Conventions in common guide.

    backport: havana
    Change-Id: I6851ef705247d619e78fb63cbcdf1ce804a548f1
    Partial-Bug: #1121866

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

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

Changed in openstack-manuals:
assignee: chandankumar (chandankumar-093047) → Lana (loquacity)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-manuals (stable/havana)

Fix proposed to branch: stable/havana
Review: https://review.openstack.org/59509

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-manuals (stable/havana)

Reviewed: https://review.openstack.org/59509
Committed: http://github.com/openstack/openstack-manuals/commit/0eeb998b17485d1e5c699d48cced76f605a46e1e
Submitter: Jenkins
Branch: stable/havana

commit 0eeb998b17485d1e5c699d48cced76f605a46e1e
Author: Chandan kumar <email address hidden>
Date: Wed Nov 27 11:40:12 2013 +0530

    Added complete Doc Conventions in common guide.

    Not backported since it does not exist in havana:
     doc/common/section_keystone-concepts-domain-management.xml

    backport: havana
    Change-Id: I6851ef705247d619e78fb63cbcdf1ce804a548f1
    Partial-Bug: #1121866
    (cherry picked from commit 201f5c66390d8c614d1e487d2e57d36149efeb50)

Changed in openstack-manuals:
assignee: Lana (loquacity) → chandankumar (chandankumar-093047)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-manuals (master)

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

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

Reviewed: https://review.openstack.org/59482
Committed: http://github.com/openstack/openstack-manuals/commit/4e672cc0c848c3f51d4203f10c5f3ccfee6cc79c
Submitter: Jenkins
Branch: master

commit 4e672cc0c848c3f51d4203f10c5f3ccfee6cc79c
Author: Chandan Kumar <email address hidden>
Date: Mon Dec 2 22:18:28 2013 +0530

    Added Doc conventions to glossary.

    Change-Id: Icf2dcc52948e9d64568a0803a8a085f07abee4c6
    Partial-Bug: #1121866

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

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

Changed in openstack-manuals:
assignee: chandankumar (chandankumar-093047) → Diane Fleming (diane-fleming)
Changed in openstack-manuals:
assignee: Diane Fleming (diane-fleming) → chandankumar (chandankumar-093047)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-manuals (master)

Reviewed: https://review.openstack.org/59620
Committed: http://github.com/openstack/openstack-manuals/commit/77ec2d6e4cc5cf50e6f1c1ffa4ecdf7540f5512f
Submitter: Jenkins
Branch: master

commit 77ec2d6e4cc5cf50e6f1c1ffa4ecdf7540f5512f
Author: Chandan kumar <email address hidden>
Date: Tue Dec 3 10:50:35 2013 +0530

    Added complete Doc Convention to Security Guide.

    Change-Id: I8310331f48399310d1a5d7af88bd91fba20ea89c
    Partial-Bug: #1121866

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

Reviewed: https://review.openstack.org/59930
Committed: http://github.com/openstack/openstack-manuals/commit/3973d7eecbce631dd7652c7aca362a48e15cea93
Submitter: Jenkins
Branch: master

commit 3973d7eecbce631dd7652c7aca362a48e15cea93
Author: Chandan kumar <email address hidden>
Date: Wed Dec 4 14:54:58 2013 +0530

    Added complete Doc Conventions in Install Guide.

    backport: havana

    Change-Id: Icd74a1a4db8ec477e48d49475c405d3b09e52c1c
    Partial-Bug: #1121866

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-manuals (stable/havana)

Fix proposed to branch: stable/havana
Review: https://review.openstack.org/60493

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

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

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

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

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

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-manuals (stable/havana)

Reviewed: https://review.openstack.org/60493
Committed: http://github.com/openstack/openstack-manuals/commit/e9e33677699758b33209e411063ccfd53bdb46f6
Submitter: Jenkins
Branch: stable/havana

commit e9e33677699758b33209e411063ccfd53bdb46f6
Author: Chandan kumar <email address hidden>
Date: Wed Dec 4 14:54:58 2013 +0530

    Added complete Doc Conventions in Install Guide.

    backport: havana

    Change-Id: Icd74a1a4db8ec477e48d49475c405d3b09e52c1c
    Partial-Bug: #1121866
    (cherry picked from commit 3973d7eecbce631dd7652c7aca362a48e15cea93)

Changed in openstack-manuals:
assignee: chandankumar (chandankumar-093047) → Diane Fleming (diane-fleming)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-manuals (master)

Reviewed: https://review.openstack.org/60764
Committed: http://github.com/openstack/openstack-manuals/commit/3714af43173676197bf9e539a19440da682a4a03
Submitter: Jenkins
Branch: master

commit 3714af43173676197bf9e539a19440da682a4a03
Author: Chandan kumar <email address hidden>
Date: Mon Dec 9 13:38:57 2013 +0530

    Added Complete Doc conventions in user-guide.

    Change-Id: Ibbc5cd3be6343a05a0537508f6e580a597447af4
    Partial-Bug: #1121866

Changed in openstack-manuals:
assignee: Diane Fleming (diane-fleming) → chandankumar (chandankumar-093047)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

commit b1b61b700a0d7a3a7ede72105abae7a1730d4b0e
Author: Chandan kumar <email address hidden>
Date: Mon Dec 9 14:03:06 2013 +0530

    Added Complete Doc conventions to user-guide-admin.

    Change-Id: I1c9a4d1a20a0dacf88fab705a0226ed1f7a39a8f
    Closes-Bug: #1121866

Changed in openstack-manuals:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

commit 149d0e1888086e3a8b8d8f94adbf6ffb9feec9a0
Author: Lana Brindley <email address hidden>
Date: Thu Nov 28 15:34:07 2013 +1000

    General updates to Compute for style and convention

    Editing the top third of the compute chapter. Mostly grammar, wording,
    style, convention, etc. Some minor section-level editing to improve
    readability. Watch this space for more edits on these bugs.

    Change-Id: If541f4a5e20251c94f6cbf416ff7c0d0e4c66892
    Partial-Bug: #1251195
    Partial-Bug: #1121866

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

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

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

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

commit c90f87d082fc9361cec9fb33c082b4788326dfc1
Author: Summer Long <email address hidden>
Date: Fri Jan 10 16:07:10 2014 +1000

    Small edits and a couple of tag fixes.

    Partial-Bug: #1121866

    Change-Id: I074dc21aa2d189fde9bc14ddce394071f6acc5bd

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

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

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

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

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

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

commit 100441efe6df61d2b8d4bba02f8dc50133bb5301
Author: Summer Long <email address hidden>
Date: Sat Mar 1 22:56:32 2014 +1000

    Minor edits for the Config Ref Guide.

    Minor edits (found in the last release), including link and case correction, and service-name updates.

    Change-Id: I5410cf4b214800f9be433a513a320d69bc303208
    Partial-Bug: #1121866

Changed in openstack-api-site:
assignee: nobody → Diane Fleming (diane-fleming)
Changed in openstack-api-site:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to api-site (master)

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

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

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

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

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

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

Reviewed: https://review.openstack.org/185255
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=eb01cdcf9390d303f3ce7d5ffd5422bbbac9e46f
Submitter: Jenkins
Branch: master

commit eb01cdcf9390d303f3ce7d5ffd5422bbbac9e46f
Author: Diane Fleming <email address hidden>
Date: Sat May 23 17:42:28 2015 -0500

    Change "keystone" to OpenStack Identity

    Change-Id: Id9143ea5cf52091083cea40696d6e2cd6806f035
    Partial-Bug: #1121866

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

Reviewed: https://review.openstack.org/185455
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=d0cd5ee68bfa019268622f715947a8897c432783
Submitter: Jenkins
Branch: master

commit d0cd5ee68bfa019268622f715947a8897c432783
Author: Diane Fleming <email address hidden>
Date: Mon May 25 16:30:48 2015 -0500

    Change cinder to OpenStack Block Storage

    Change-Id: I017c9e7002ff19be2e0d9581181467c6055c862a
    Partial-Bug: #1121866

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

Reviewed: https://review.openstack.org/185456
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=1b258e84562180d67b3d5ebc24607b400d30bfe3
Submitter: Jenkins
Branch: master

commit 1b258e84562180d67b3d5ebc24607b400d30bfe3
Author: Diane Fleming <email address hidden>
Date: Mon May 25 16:36:52 2015 -0500

    Change heat -> Orchestration

    Change-Id: I4f1bae33dd5568022c085122462848b1c32d885d
    Partial-Bug: #1121866

Changed in openstack-api-site:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/185458
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=e217f8bdcd8bd5d72b7c4433cf8b201dabe634e7
Submitter: Jenkins
Branch: master

commit e217f8bdcd8bd5d72b7c4433cf8b201dabe634e7
Author: Diane Fleming <email address hidden>
Date: Mon May 25 16:43:19 2015 -0500

    Change neutron -> OpenStack Networking

    Change-Id: I8bccef3bc6a2ded9c1acc2f9e20c30c11289c719
    Closes-Bug: #1121866

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/openstack-manuals 15.0.0

This issue was fixed in the openstack/openstack-manuals 15.0.0 release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

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