From 072fc1d6190994b09dd7ef271e38c50b820e5fdd Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Fri, 19 Jun 2015 13:23:52 +0000 Subject: [PATCH] Fix up README to work with the release tools Add links to the bug tracker and source in a way the release script can find them. Move the contributing instructions to a separate file, where github will pick them up and the release tools won't be confused by the urls. Change-Id: Icbc1fdde3245ef6aa750bd44601adb1514763034 --- CONTRIBUTING.rst | 26 ++++++++++++++++++++++++++ README.rst | 31 +++---------------------------- 2 files changed, 29 insertions(+), 28 deletions(-) create mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 00000000..a16fd1f6 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,26 @@ +Our community welcomes all people interested in open source cloud computing, +and encourages you to join the `OpenStack Foundation `_. +The best way to get involved with the community is to talk with others online +or at a meetup and offer contributions through our processes, the `OpenStack +wiki `_, blogs, or on IRC at ``#openstack`` +on ``irc.freenode.net``. + +We welcome all types of contributions, from blueprint designs to documentation +to testing to deployment scripts. + +If you would like to contribute to the development, +you must follow the steps in this page: + + http://docs.openstack.org/infra/manual/developers.html + +Once those steps have been completed, changes to OpenStack +should be submitted for review via the Gerrit tool, following +the workflow documented at: + + http://docs.openstack.org/infra/manual/developers.html#development-workflow + +Pull requests submitted through GitHub will be ignored. + +Bugs should be filed on Launchpad, not GitHub: + + https://bugs.launchpad.net/openstack-manuals diff --git a/README.rst b/README.rst index 91ed7912..b8261c18 100644 --- a/README.rst +++ b/README.rst @@ -100,31 +100,6 @@ you set it, you need to use it every time. Also note that these are optional settings, the logic in the tool is sufficient for many of the books. -Contributing -============ -Our community welcomes all people interested in open source cloud computing, -and encourages you to join the `OpenStack Foundation `_. -The best way to get involved with the community is to talk with others online -or at a meetup and offer contributions through our processes, the `OpenStack -wiki `_, blogs, or on IRC at ``#openstack`` -on ``irc.freenode.net``. - -We welcome all types of contributions, from blueprint designs to documentation -to testing to deployment scripts. - -If you would like to contribute to the development, -you must follow the steps in this page: - - http://docs.openstack.org/infra/manual/developers.html - -Once those steps have been completed, changes to OpenStack -should be submitted for review via the Gerrit tool, following -the workflow documented at: - - http://docs.openstack.org/infra/manual/developers.html#development-workflow - -Pull requests submitted through GitHub will be ignored. - -Bugs should be filed on Launchpad, not GitHub: - - https://bugs.launchpad.net/openstack-manuals +* License: Apache License, Version 2.0 +* Source: http://git.openstack.org/cgit/openstack/openstack-doc-tools +* Bugs: http://bugs.launchpad.net/openstack-manuals