diff options
| author | Monty Taylor <mordred@inaugust.com> | 2014-11-21 10:53:36 -0500 |
|---|---|---|
| committer | Nikhil Manchanda <SlickNik@gmail.com> | 2014-12-05 23:24:53 -0800 |
| commit | 28e8fcf0ee3f7423e0f128bf0aafbff120450378 (patch) | |
| tree | bce282f7ed8a1ceee093a2e919af4f06975ccada /README.rst | |
| parent | b2aa4f993e4559fee0410bd7b69753e4ab8c0e2c (diff) | |
| download | trove-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
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 90 |
1 files changed, 0 insertions, 90 deletions
@@ -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. |