From a277ed550b50e48d46bbb05b6091ba37ade0399a Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sun, 17 Aug 2014 06:34:02 +0200 Subject: [PATCH] Rename marconi to zaqar Rename everywhere, sync template.rst with version in specs. Adjust publishing URL, specs will show up on specs.openstack.org. Create link to specs directory so that building works - like it's done in other specs repositories. Implements blueprint: project-rename Change-Id: Ife866fafb9e1d94935bd0c02949e1cd9d5a9c281 --- .coveragerc | 4 ++-- CONTRIBUTING.rst | 4 ++-- README.rst | 8 ++++---- doc/source/conf.py | 6 +++--- doc/source/contributing.rst | 4 ++-- doc/source/index.rst | 11 +++-------- doc/source/readme.rst | 8 ++++---- doc/source/specs | 1 + doc/source/template.rst | 32 ++++++++++++++++---------------- setup.cfg | 4 ++-- specs/template.rst | 6 +++--- template.rst | 32 ++++++++++++++++---------------- 12 files changed, 58 insertions(+), 62 deletions(-) create mode 120000 doc/source/specs diff --git a/.coveragerc b/.coveragerc index 611f234..52c42a6 100644 --- a/.coveragerc +++ b/.coveragerc @@ -1,7 +1,7 @@ [run] branch = True -source = marconi-specs -omit = marconi-specs/tests/*,marconi-specs/openstack/* +source = zaqar-specs +omit = zaqar-specs/tests/*,zaqar-specs/openstack/* [report] ignore-errors = True \ No newline at end of file diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 24789b2..1a64cd1 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,5 +1,5 @@ ============================================= -Contributing to: marconi-specs +Contributing to: zaqar-specs ============================================= If you would like to contribute to the development of OpenStack, @@ -18,4 +18,4 @@ Pull requests submitted through GitHub will be ignored. Bugs should be filed on Launchpad, not GitHub: - https://bugs.launchpad.net/marconi \ No newline at end of file + https://bugs.launchpad.net/zaqar diff --git a/README.rst b/README.rst index 9298c11..1623c87 100644 --- a/README.rst +++ b/README.rst @@ -1,13 +1,13 @@ =============================== -marconi-specs +zaqar-specs =============================== -Queuing Service (Marconi) Specifications +Queuing Service (Zaqar) Specifications * Free software: Apache license -* Documentation: http://docs.openstack.org/developer/marconi-specs +* Documentation: http://specs.openstack.org/openstack/zaqar-specs Features -------- -* TODO \ No newline at end of file +* TODO diff --git a/doc/source/conf.py b/doc/source/conf.py index 7d97645..993ee16 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -45,8 +45,8 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'marconi-specs' -copyright = u'2013, OpenStack Foundation' +project = u'zaqar-specs' +copyright = u'2014, OpenStack Foundation' # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -80,4 +80,4 @@ latex_documents = [ ] # Example configuration for intersphinx: refer to the Python standard library. -#intersphinx_mapping = {'http://docs.python.org/': None} \ No newline at end of file +#intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index 24789b2..1a64cd1 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -1,5 +1,5 @@ ============================================= -Contributing to: marconi-specs +Contributing to: zaqar-specs ============================================= If you would like to contribute to the development of OpenStack, @@ -18,4 +18,4 @@ Pull requests submitted through GitHub will be ignored. Bugs should be filed on Launchpad, not GitHub: - https://bugs.launchpad.net/marconi \ No newline at end of file + https://bugs.launchpad.net/zaqar diff --git a/doc/source/index.rst b/doc/source/index.rst index aa0cba0..aba3b09 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,19 +1,14 @@ -.. marconi-specs documentation master file, created by - sphinx-quickstart on Tue Jul 9 22:26:36 2013. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -marconi-specs Design Specifications +zaqar-specs Design Specifications ================================================== .. toctree:: :glob: :maxdepth: 2 - ../../specs/* + specs/* -marconi-specs Repository Information +zaqar-specs Repository Information =================================================== .. toctree:: diff --git a/doc/source/readme.rst b/doc/source/readme.rst index 9298c11..1623c87 100644 --- a/doc/source/readme.rst +++ b/doc/source/readme.rst @@ -1,13 +1,13 @@ =============================== -marconi-specs +zaqar-specs =============================== -Queuing Service (Marconi) Specifications +Queuing Service (Zaqar) Specifications * Free software: Apache license -* Documentation: http://docs.openstack.org/developer/marconi-specs +* Documentation: http://specs.openstack.org/openstack/zaqar-specs Features -------- -* TODO \ No newline at end of file +* TODO diff --git a/doc/source/specs b/doc/source/specs new file mode 120000 index 0000000..87a4030 --- /dev/null +++ b/doc/source/specs @@ -0,0 +1 @@ +../../specs \ No newline at end of file diff --git a/doc/source/template.rst b/doc/source/template.rst index 651d823..2cfae1c 100644 --- a/doc/source/template.rst +++ b/doc/source/template.rst @@ -1,14 +1,12 @@ -:: - -This work is licensed under a Creative Commons Attribution 3.0 Unported License. -http://creativecommons.org/licenses/by/3.0/legalcode - .. This template should be in ReSTructured text. The filename in the git repository should match the launchpad URL, for example a URL of - https://blueprints.launchpad.net/marconi/+spec/awesome-thing should be named - awesome-thing.rst . Please do not delete any of the sections in this + https://blueprints.launchpad.net/zaqar/+spec/awesome-thing should be named + awesome-thing.rst. + + Please do not delete any of the sections in this template. If you have nothing to say for a whole section, just write: None + For help with syntax, see http://sphinx-doc.org/rest.html To test out your formatting, see http://www.tele3.cz/jbar/rest/rest.html @@ -18,7 +16,7 @@ http://creativecommons.org/licenses/by/3.0/legalcode Include the URL of your launchpad blueprint: -https://blueprints.launchpad.net//+spec/example +https://blueprints.launchpad.net/zaqar/+spec/example Introduction paragraph -- why are we doing anything? @@ -36,8 +34,6 @@ propose to solve this problem? If this is one part of a larger effort make it clear where this piece ends. In other words, what's the scope of this effort? -Include where in the marconi tree hierarchy this will reside. - Alternatives ------------ @@ -59,14 +55,14 @@ primary author and contact. Primary assignee: -Can optionally can list additional ids if they intend on doing -substantial implementation work on this blueprint. +Can list additional ids if they intend on doing substantial implementation work +on this blueprint. Milestones ---------- Target Milestone for completion: - Juno-1 + Juno-2 Work Items ---------- @@ -79,8 +75,12 @@ but we're mostly trying to understand the timeline for implementation. Dependencies ============ -- Include specific references to specs and/or blueprints in marconi, or in other +- Include specific references to specs and/or blueprints in zaqar, or in other projects, that this one either depends on or is related to. -- Does this feature require any new library dependencies or code otherwise not - included in OpenStack? Or does it depend on a specific version of library? \ No newline at end of file +.. note:: + + This work is licensed under a Creative Commons Attribution 3.0 + Unported License. + http://creativecommons.org/licenses/by/3.0/legalcode + diff --git a/setup.cfg b/setup.cfg index 78413ef..47f8e8f 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] -name = marconi-specs -summary = Queuing Service (Marconi) Specifications +name = zaqar-specs +summary = Queuing Service (Zaqar) Specifications description-file = README.rst author = OpenStack diff --git a/specs/template.rst b/specs/template.rst index 9f25517..2cfae1c 100644 --- a/specs/template.rst +++ b/specs/template.rst @@ -1,7 +1,7 @@ .. This template should be in ReSTructured text. The filename in the git repository should match the launchpad URL, for example a URL of - https://blueprints.launchpad.net/marconi/+spec/awesome-thing should be named + https://blueprints.launchpad.net/zaqar/+spec/awesome-thing should be named awesome-thing.rst. Please do not delete any of the sections in this @@ -16,7 +16,7 @@ Include the URL of your launchpad blueprint: -https://blueprints.launchpad.net/marconi/+spec/example +https://blueprints.launchpad.net/zaqar/+spec/example Introduction paragraph -- why are we doing anything? @@ -75,7 +75,7 @@ but we're mostly trying to understand the timeline for implementation. Dependencies ============ -- Include specific references to specs and/or blueprints in marconi, or in other +- Include specific references to specs and/or blueprints in zaqar, or in other projects, that this one either depends on or is related to. .. note:: diff --git a/template.rst b/template.rst index 651d823..2cfae1c 100644 --- a/template.rst +++ b/template.rst @@ -1,14 +1,12 @@ -:: - -This work is licensed under a Creative Commons Attribution 3.0 Unported License. -http://creativecommons.org/licenses/by/3.0/legalcode - .. This template should be in ReSTructured text. The filename in the git repository should match the launchpad URL, for example a URL of - https://blueprints.launchpad.net/marconi/+spec/awesome-thing should be named - awesome-thing.rst . Please do not delete any of the sections in this + https://blueprints.launchpad.net/zaqar/+spec/awesome-thing should be named + awesome-thing.rst. + + Please do not delete any of the sections in this template. If you have nothing to say for a whole section, just write: None + For help with syntax, see http://sphinx-doc.org/rest.html To test out your formatting, see http://www.tele3.cz/jbar/rest/rest.html @@ -18,7 +16,7 @@ http://creativecommons.org/licenses/by/3.0/legalcode Include the URL of your launchpad blueprint: -https://blueprints.launchpad.net//+spec/example +https://blueprints.launchpad.net/zaqar/+spec/example Introduction paragraph -- why are we doing anything? @@ -36,8 +34,6 @@ propose to solve this problem? If this is one part of a larger effort make it clear where this piece ends. In other words, what's the scope of this effort? -Include where in the marconi tree hierarchy this will reside. - Alternatives ------------ @@ -59,14 +55,14 @@ primary author and contact. Primary assignee: -Can optionally can list additional ids if they intend on doing -substantial implementation work on this blueprint. +Can list additional ids if they intend on doing substantial implementation work +on this blueprint. Milestones ---------- Target Milestone for completion: - Juno-1 + Juno-2 Work Items ---------- @@ -79,8 +75,12 @@ but we're mostly trying to understand the timeline for implementation. Dependencies ============ -- Include specific references to specs and/or blueprints in marconi, or in other +- Include specific references to specs and/or blueprints in zaqar, or in other projects, that this one either depends on or is related to. -- Does this feature require any new library dependencies or code otherwise not - included in OpenStack? Or does it depend on a specific version of library? \ No newline at end of file +.. note:: + + This work is licensed under a Creative Commons Attribution 3.0 + Unported License. + http://creativecommons.org/licenses/by/3.0/legalcode +