diff --git a/README.rst b/README.rst index d0914b01..a0ad1a03 100644 --- a/README.rst +++ b/README.rst @@ -19,20 +19,20 @@ usage metrics, aiding in capacity planning and hardware procurement decisions. For additional information, take a look at the `Tuskar -documentation `_. +documentation `_. Installation Information ------------------------ Please see -`INSTALL.rst `_ +`INSTALL.rst `_ for an installation guide. Contributing ------------ Interested in contributing? Take a look at -`CONTRIBUTING.rst `_ +`CONTRIBUTING.rst `_ for details on how to do so. Contact Us diff --git a/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst similarity index 94% rename from CONTRIBUTING.rst rename to docs/CONTRIBUTING.rst index 06d7e0f2..be8bfbb5 100644 --- a/CONTRIBUTING.rst +++ b/docs/CONTRIBUTING.rst @@ -3,8 +3,9 @@ Contributing to Tuskar ====================== Tuskar follows the OpenStack processes when it comes to code, communication, -etc. The `repositories are hosted on Stackforge -`_, `bugs and blueprints are on Launchpad +etc. The `repositories are hosted on git.openstack.org +`_, +`bugs and blueprints are on Launchpad `_ and we use the openstack-dev mailing list (subject `[tuskar]`) and the `#tuskar` IRC channel for communication. @@ -13,7 +14,7 @@ Coding Standards ---------------- We attempt to comply with the OpenStack coding standards, defined in -https://github.com/openstack-dev/hacking/blob/master/HACKING.rst +http://docs.openstack.org/developer/hacking/ Be sure to familiarise yourself with `OpenStack's Gerrit Workflow `_. @@ -25,7 +26,7 @@ the following checklist: 2. Update the API docs (if needed) 3. Update the tests (if needed) 4. Update - `cURL commands `_ + `cURL commands `_ page (if needed) diff --git a/INSTALL.rst b/docs/INSTALL.rst similarity index 86% rename from INSTALL.rst rename to docs/INSTALL.rst index 30488e05..9c7569e4 100644 --- a/INSTALL.rst +++ b/docs/INSTALL.rst @@ -4,7 +4,7 @@ Installation Guide Tuskar source code should be pulled directly from git:: - git clone https://github.com/openstack/tuskar.git + git clone https://git.openstack.org/openstack/tuskar Dependencies @@ -14,9 +14,9 @@ Setting up a local environment for development can be done with tox:: # install prerequisites * Ubuntu/Debian: - $ sudo apt-get install python-dev swig libssl-dev python-pip libmysqlclient-dev libxml2-dev libxslt-dev + $ sudo apt-get install python-dev swig libssl-dev python-pip libmysqlclient-dev libxml2-dev libxslt-dev gcc * Fedora/RHEL: - $ sudo yum install python-devel swig openssl-devel python-pip mysql-devel libxml2-devel libxslt-devel + $ sudo yum install python-devel swig openssl-devel python-pip mysql-devel libxml2-devel libxslt-devel gcc # Note that as of Fedora 19, you need to use the community upstream for mysql, called mariadb-devel @@ -65,7 +65,7 @@ to your local copy of the tripleo-heat-templates. At tuskar startup, if the directory specified by tht_local_dir in your tuskar.conf doesn't exist startup will fail. You can clone the templates: - (sudo) git clone https://github.com/openstack/tripleo-heat-templates.git /etc/tuskar/tripleo-heat-templates/ + (sudo) git clone https://git.openstack.org/openstack/tripleo-heat-templates /etc/tuskar/tripleo-heat-templates/ We need to initialise the database schema:: @@ -97,7 +97,7 @@ Next, you can run a script to populate the DB with some sample data:: This will create 2 Resource Classes and three Racks. You need to have the Tuskar API server running. You can see more examples of using the API at our `cURL -Commands page `_. +Commands page `_. Running Tuskar API @@ -116,6 +116,6 @@ Contributing ------------ For additional developer information, take a look at -`CONTRIBUTING.rst `_ +`CONTRIBUTING.rst `_ and the -`Tuskar website `_. +`developer documentation `_. diff --git a/docs/debugging-with-ipython.rst b/docs/debugging-with-ipython.rst index e9b417e4..55f1cb99 100644 --- a/docs/debugging-with-ipython.rst +++ b/docs/debugging-with-ipython.rst @@ -32,4 +32,4 @@ Tweaks ------ `ipythonrc `_ --> Colors on console, tab completetion for methods and more ;-) +-> Colors on console, tab completion for methods and more ;-) diff --git a/docs/demo-data-script.rst b/docs/demo-data-script.rst index e69a7b00..00db1c55 100644 --- a/docs/demo-data-script.rst +++ b/docs/demo-data-script.rst @@ -107,7 +107,7 @@ Create Resource Classes ----------------------- This command creates two Resource Classes. The compute Resource Class contains two Racks -and a total of six Nodes. The non-compute Resoure Class contains one Rack and one Node. +and a total of six Nodes. The non-compute Resource Class contains one Rack and one Node. :: diff --git a/docs/index.rst b/docs/index.rst index 2cd92e95..36bc3133 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,16 +26,14 @@ demo! `_ - *TODO* feature examples - *TODO* link to high-level portion of FAQ -- `Recommended - reading `_ +- `Recommended reading `_ Related Projects ---------------- -- `tuskar-ui `_ - Built on top - of Horizon, tuskar-ui provides dashboard access to Tuskar - functionality. -- `python-tuskarclient `_ +- `tuskar-ui `_ - Built on top + of Horizon, tuskar-ui provides dashboard access to Tuskar functionality. +- `python-tuskarclient `_ - A Python client for the Tuskar API, python-tuskarclient is utilized by tuskar-ui. @@ -45,24 +43,17 @@ Developer Information Install and Contribute ---------------------- -- `Install - Guide `_ -- `Contributing - Guide `_ -- `Debugging with - iPython `_ -- `Demo Data - Script `_ +- `Install Guide `_ +- `Contributing Guide `_ +- `Debugging with iPython `_ +- `Demo Data Script `_ API --- -- `API - Information `_ -- `cURL - Commands `_ -- `Resource Class Demo - Script `_ +- `API Information `_ +- `cURL Commands `_ +- `Resource Class Demo Script `_ (uses cURL) HEAT Integration diff --git a/docs/recommended-reading.rst b/docs/recommended-reading.rst index 9e686b2c..4664cf3c 100644 --- a/docs/recommended-reading.rst +++ b/docs/recommended-reading.rst @@ -5,15 +5,14 @@ Recommended Reading Relevant OpenStack Projects --------------------------- -- `nova `_ -- `ceilometer `_ -- `oslo-incubator `_ -- `oslo.config `_ This is a +- `nova `_ +- `ceilometer `_ +- `oslo-incubator `_ +- `oslo.config `_ This is a library for parsing configuration files and command line arguments. It is maintained by Mark McLoughlin. -- `hacking `_ This enforces - openstack community standards, described - `here `_. +- `hacking `_ This enforces + openstack community coding style guidelines General Python/Frameworks ------------------------- diff --git a/setup.cfg b/setup.cfg index 444cc47f..2a69ab5d 100644 --- a/setup.cfg +++ b/setup.cfg @@ -6,7 +6,7 @@ description-file = README.rst author = Mark McLoughlin author-email = markmc@redhat.com -home-page = https://github.com/openstack/tuskar +home-page = http://git.openstack.org/cgit/openstack/tuskar classifier = Environment :: OpenStack Intended Audience :: Information Technology