summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMonty Taylor <mordred@inaugust.com>2014-11-21 10:53:36 -0500
committerNikhil Manchanda <SlickNik@gmail.com>2014-12-05 23:24:53 -0800
commit28e8fcf0ee3f7423e0f128bf0aafbff120450378 (patch)
treebce282f7ed8a1ceee093a2e919af4f06975ccada
parentb2aa4f993e4559fee0410bd7b69753e4ab8c0e2c (diff)
downloadtrove-28e8fcf0ee3f7423e0f128bf0aafbff120450378.tar.gz
Clean up github references from docs
OpenStack hosts things in places that are not github. Also, it seems that there is a big blob of unrelated readme in the README file. Closes-Bug: 1399839 Change-Id: I70cc6772b50591c4b3badd6c92567a7a6541bacf
-rw-r--r--CONTRIBUTING.rst75
-rw-r--r--README.rst90
-rw-r--r--doc/source/dev/install.rst10
-rw-r--r--doc/source/dev/manual_install.rst8
-rw-r--r--doc/source/index.rst12
5 files changed, 88 insertions, 107 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index e81157cd..56806005 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -1,3 +1,11 @@
+============
+Contributing
+============
+
+Our community welcomes all people interested in open source cloud
+computing, and encourages you to join the `OpenStack Foundation
+<http://www.openstack.org/join>`_.
+
If you would like to contribute to the development of OpenStack,
you must follow the steps documented at:
@@ -9,14 +17,22 @@ the workflow documented at:
http://wiki.openstack.org/GerritWorkflow
-Pull requests submitted through GitHub will be ignored.
+(Pull requests submitted through GitHub will be ignored.)
Bugs should be filed on Launchpad, not GitHub:
https://bugs.launchpad.net/trove
+We welcome all types of contributions, from blueprint designs to
+documentation to testing to deployment scripts. 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 <http://wiki.openstack.org>`_, blogs, or on IRC at
+``#openstack-trove`` on ``irc.freenode.net``.
+
+
Code Reviews
-------------
+============
We value your contribution in reviewing code changes submitted by
others, as this helps increase the quality of the product as well.
@@ -74,4 +90,59 @@ Other references:
- https://review.openstack.org/#/c/116176/
+Trove Documentation
+===================
+
+This repository also contains the following OpenStack manual:
+
+* Database Services API Reference
+
+Prerequisites for Building the Documentation
+--------------------------------------------
+`Apache Maven <http://maven.apache.org/>`_ must be installed to build the
+documentation.
+
+To install Maven 3 for Ubuntu 12.04 and later, and Debian wheezy and later::
+
+ apt-get install maven
+
+On Fedora 15 and later::
+
+ yum install maven3
+
+Building
+--------
+The manuals are in the ``apidocs`` directory.
+
+To build a specific guide, look for a ``pom.xml`` file within a subdirectory,
+then run the ``mvn`` command in that directory. For example::
+
+ cd apidocs
+ mvn clean generate-sources
+
+The generated PDF documentation file is::
+
+ apidocs/target/docbkx/webhelp/cdb-devguide/cdb-devguide-reviewer.pdf
+
+The root of the generated HTML documentation is::
+
+ apidocs/target/docbkx/webhelp/cdb-devguide/content/index.html
+
+Testing of changes and building of the manual
+----------------------------------------------
+
+Install the python tox package and run ``tox`` from the top-level
+directory to use the same tests that are done as part of our Jenkins
+gating jobs.
+
+If you like to run individual tests, run:
+
+ * ``tox -e checkniceness`` - to run the niceness tests
+ * ``tox -e checksyntax`` - to run syntax checks
+ * ``tox -e checkdeletions`` - to check that no deleted files are referenced
+ * ``tox -e checkbuild`` - to actually build the manual
+tox will use the `openstack-doc-tools package
+<https://github.com/openstack/openstack-doc-tools>`_ for execution of
+these tests. openstack-doc-tools has a requirement on maven for the
+build check.
diff --git a/README.rst b/README.rst
index 0924eeda..b2cedaae 100644
--- a/README.rst
+++ b/README.rst
@@ -55,93 +55,3 @@ If you want to run only the tests in one file you can use testtools e.g.
.. code-block:: bash
$ python -m testtools.run trove.tests.unittests.python.module.path
-
-======
-Docs
-======
-
-This repository contains the following OpenStack manual:
-
-* Database Services API Reference
-
-Prerequisites
--------------
-`Apache Maven <http://maven.apache.org/>`_ must be installed to build the
-documentation.
-
-To install Maven 3 for Ubuntu 12.04 and later, and Debian wheezy and later::
-
- apt-get install maven
-
-On Fedora 15 and later::
-
- yum install maven3
-
-Building
---------
-The manuals are in the ``apidocs`` directory.
-
-To build a specific guide, look for a ``pom.xml`` file within a subdirectory,
-then run the ``mvn`` command in that directory. For example::
-
- cd apidocs
- mvn clean generate-sources
-
-The generated PDF documentation file is::
-
- apidocs/target/docbkx/webhelp/cdb-devguide/cdb-devguide-reviewer.pdf
-
-The root of the generated HTML documentation is::
-
- apidocs/target/docbkx/webhelp/cdb-devguide/content/index.html
-
-Testing of changes and building of the manual
-----------------------------------------------
-
-Install the python tox package and run ``tox`` from the top-level
-directory to use the same tests that are done as part of our Jenkins
-gating jobs.
-
-If you like to run individual tests, run:
-
- * ``tox -e checkniceness`` - to run the niceness tests
- * ``tox -e checksyntax`` - to run syntax checks
- * ``tox -e checkdeletions`` - to check that no deleted files are referenced
- * ``tox -e checkbuild`` - to actually build the manual
-
-tox will use the `openstack-doc-tools package
-<https://github.com/openstack/openstack-doc-tools>`_ for execution of
-these tests. openstack-doc-tools has a requirement on maven for the
-build check.
-
-
-Contributing
-============
-
-Our community welcomes all people interested in open source cloud
-computing, and encourages you to join the `OpenStack Foundation
-<http://www.openstack.org/join>`_.
-
-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 <http://wiki.openstack.org>`_, 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 documents, please see the
-`Documentation HowTo <https://wiki.openstack.org/wiki/Documentation/HowTo>`_.
-
-Bugs
-====
-
-Bugs should be filed on Launchpad, not GitHub:
-
- https://bugs.launchpad.net/openstack-api-site/
-
-
-Installing
-==========
-Refer to http://docs.openstack.org to see where these documents are published
-and to learn more about the OpenStack project.
diff --git a/doc/source/dev/install.rst b/doc/source/dev/install.rst
index 39c2cecc..10bb4759 100644
--- a/doc/source/dev/install.rst
+++ b/doc/source/dev/install.rst
@@ -6,7 +6,7 @@ Trove Installation
Trove is constantly under development. The easiest way to install
Trove is using the Trove integration scripts that can be found in
-github in the `Trove Integration Repository`_.
+git in the `Trove Integration Repository`_.
Steps to set up a Trove Developer Environment
@@ -22,7 +22,7 @@ Installing trove-integration
* Make sure we have git installed::
# apt-get update
- # apt-get install git-core -y
+ # apt-get install git -y
* Add a user named ubuntu if you do not already have one::
@@ -41,7 +41,7 @@ Installing trove-integration
* Clone this repo::
- # git clone https://github.com/openstack/trove-integration.git
+ # git clone https://git.openstack.org/openstack/trove-integration.git
* cd into the scripts directory::
@@ -105,5 +105,5 @@ trove-integration scripts, please look at the `README documentation`_
in the `Trove Integration Repository`_.
-.. _Trove Integration Repository: https://www.github.com/openstack/trove-integration
-.. _README documentation: https://github.com/openstack/trove-integration/blob/master/README.md
+.. _Trove Integration Repository: https://git.openstack.org/cgit/openstack/trove-integration
+.. _README documentation: https://git.openstack.org/cgit/openstack/trove-integration/plain/README.md
diff --git a/doc/source/dev/manual_install.rst b/doc/source/dev/manual_install.rst
index dd315c96..4c658d23 100644
--- a/doc/source/dev/manual_install.rst
+++ b/doc/source/dev/manual_install.rst
@@ -107,8 +107,8 @@ Obtain Trove
------------
* Get Trove's sources from git::
- # git clone https://github.com/openstack/trove.git
- # git clone https://github.com/openstack/python-troveclient.git
+ # git clone https://git.openstack.org/openstack/trove.git
+ # git clone https://git.openstack.org/openstack/python-troveclient.git
-------------
Install Trove
@@ -120,13 +120,13 @@ Install Trove
* Resolve dependency conflicts (if there are any)
-Trove is being built and tested against latest versions of OpenStack components that can be obtained from GitHub.
+Trove is being built and tested against latest versions of OpenStack components that can be obtained from git.
But setup downloads dependencies from PyPI which may contain outdated versions. This may cause a dependency conflicts.
E.g. for now python-cinderclient from PyPI requires older 'requests' than one installed by default, so fix it manually::
# pip install --upgrade 'requests<1.2.3'
-or consider manual installing fresh OpenStack components from GitHub
+or consider manual installing fresh OpenStack components from git
* Install Trove itself::
diff --git a/doc/source/index.rst b/doc/source/index.rst
index e7774460..72ce5aa4 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -26,7 +26,7 @@ Installation And Deployment
Trove is constantly under development. The easiest way to install
Trove is using the Trove integration scripts that can be found in
-github in the `Trove Integration`_ Repository.
+git in the `Trove Integration`_ Repository.
For further details on how to install Trove using the integration
scripts please refer to the :doc:`dev/install` page.
@@ -54,7 +54,7 @@ functionality, the following resources are provided.
- `Trove Client`_
* `Trove Wiki`_ on OpenStack
-* `Trove API Documentation`_ on github
+* `Trove API Documentation`_ on docs.openstack.org
Search Trove Documentation
@@ -64,7 +64,7 @@ Search Trove Documentation
.. _Trove Wiki: https://wiki.openstack.org/wiki/Trove
-.. _Trove: https://www.github.com/openstack/trove
-.. _Trove Integration: https://www.github.com/openstack/trove-integration
-.. _Trove Client: https://www.github.com/openstack/python-troveclient
-.. _Trove API Documentation: https://github.com/openstack/database-api/blob/master/openstack-database-api/src/markdown/database-api-v1.md
+.. _Trove: https://git.openstack.org/cgit/openstack/trove
+.. _Trove Integration: https://git.openstack.org/cgit/openstack/trove-integration
+.. _Trove Client: https://git.openstack.org/cgit/openstack/python-troveclient
+.. _Trove API Documentation: http://developer.openstack.org/api-ref-databases-v1.html