Fix developer documentation

This patch contains a few documentation fixes:
- Add missing gcc dependency to installation instructions
- Move CONTRIBUTING.rst and INSTALL.rst to docs folder
- Replace references to stackforge with openstack
- Replace GitHub references with git.openstack.org
- Correct invalid links
- Fix typos

Change-Id: I6922b84c6b4c6b1f517802a8b83bbdbd78a52c7d

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 <https://github.com/openstack/tuskar/blob/master/docs/index.rst>`_.
+documentation <http://git.openstack.org/cgit/openstack/tuskar/tree/docs/index.rst>`_.
 
 Installation Information
 ------------------------
 
 Please see
-`INSTALL.rst <https://github.com/openstack/tuskar/blob/master/INSTALL.rst>`_
+`INSTALL.rst <docs/INSTALL.rst>`_
 for an installation guide.
 
 Contributing
 ------------
 
 Interested in contributing?  Take a look at
-`CONTRIBUTING.rst <https://github.com/openstack/tuskar/blob/master/CONTRIBUTING.rst>`_
+`CONTRIBUTING.rst <docs/CONTRIBUTING.rst>`_
 for details on how to do so.
 
 Contact Us

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
+etc. The `repositories are hosted on git.openstack.org
-<https://github.com/stackforge/tuskar>`_, `bugs and blueprints are on Launchpad
+<http://git.openstack.org/cgit/openstack/tuskar>`_,
+`bugs and blueprints are on Launchpad
 <https://launchpad.net/tuskar>`_ 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
 <https://wiki.openstack.org/wiki/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 <https://github.com/stackforge/tuskar/blob/master/docs/api/curl.rst>`_
+   `cURL commands <docs/api/curl.rst>`_
    page (if needed)
 
 

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 <https://github.com/openstack/tuskar/blob/master/docs/api/curl.rst>`_.
+Commands page <docs/api/curl.rst>`_.
 
 
 Running Tuskar API
@@ -116,6 +116,6 @@ Contributing
 ------------
 
 For additional developer information, take a look at
-`CONTRIBUTING.rst <https://github.com/openstack/tuskar/blob/master/CONTRIBUTING.rst>`_
+`CONTRIBUTING.rst <docs/CONTRIBUTING.rst>`_
 and the
-`Tuskar website <https://github.com/openstack/tuskar/blob/master/docs/index.rst>`_.
+`developer documentation <docs/index.rst>`_.

docs/debugging-with-ipython.rst

@@ -32,4 +32,4 @@ Tweaks
 ------
 
 `ipythonrc <https://github.com/queezythegreat/settings/tree/master/ipython>`_
--> Colors on console, tab completetion for methods and more ;-)
+-> Colors on console, tab completion for methods and more ;-)

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.
 
 ::
 

docs/index.rst

@@ -26,16 +26,14 @@ demo! <https://www.youtube.com/watch?v=VEY035-Lyzo>`_
 
 -  *TODO* feature examples
 -  *TODO* link to high-level portion of FAQ
--  `Recommended
+-  `Recommended reading <docs/recommended-reading.rst>`_
-   reading <https://github.com/openstack/tuskar/blob/master/docs/recommended-reading.rst>`_
 
 Related Projects
 ----------------
 
--  `tuskar-ui <https://github.com/openstack/tuskar-ui>`_ - Built on top
+-  `tuskar-ui <http://git.openstack.org/cgit/openstack/tuskar-ui>`_ - Built on top
-   of Horizon, tuskar-ui provides dashboard access to Tuskar
+   of Horizon, tuskar-ui provides dashboard access to Tuskar functionality.
-   functionality.
+-  `python-tuskarclient <http://git.openstack.org/cgit/openstack/python-tuskarclient>`_
--  `python-tuskarclient <https://github.com/openstack/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
+-  `Install Guide <docs/INSTALL.rst>`_
-   Guide <https://github.com/openstack/tuskar/blob/master/INSTALL.rst>`_
+-  `Contributing Guide <docs/CONTRIBUTING.rst>`_
--  `Contributing
+-  `Debugging with iPython <docs/debugging-with-ipython.rst>`_
-   Guide <https://github.com/openstack/tuskar/blob/master/CONTRIBUTING.rst>`_
+-  `Demo Data Script <docs/demo-data-script.rst>`_
--  `Debugging with
-   iPython <https://github.com/openstack/tuskar/blob/master/docs/debugging-with-ipython.rst>`_
--  `Demo Data
-   Script <https://github.com/openstack/tuskar/blob/master/docs/demo-data-script.rst>`_
 
 API
 ---
 
--  `API
+-  `API Information <docs/api/api.md>`_
-   Information <https://github.com/openstack/tuskar/blob/master/docs/api/api.md>`_
+-  `cURL Commands <docs/api/curl.rst>`_
--  `cURL
+-  `Resource Class Demo Script <docs/resource-class-demo-script.rst>`_
-   Commands <https://github.com/openstack/tuskar/blob/master/docs/api/curl.rst>`_
--  `Resource Class Demo
-   Script <https://github.com/openstack/tuskar/blob/master/docs/resource-class-demo-script.rst>`_
    (uses cURL)
 
 HEAT Integration

docs/recommended-reading.rst

@@ -5,15 +5,14 @@ Recommended Reading
 Relevant OpenStack Projects
 ---------------------------
 
--  `nova <https://github.com/openstack/nova>`_
+-  `nova <http://docs.openstack.org/developer/nova>`_
--  `ceilometer <https://github.com/openstack/ceilometer>`_
+-  `ceilometer <http://docs.openstack.org/developer/ceilometer>`_
--  `oslo-incubator <https://github.com/openstack/oslo-incubator>`_
+-  `oslo-incubator <http://docs.openstack.org/developer/oslo-incubator>`_
--  `oslo.config <https://github.com/openstack/oslo.config>`_ This is a
+-  `oslo.config <http://docs.openstack.org/developer/oslo.config>`_ This is a
    library for parsing configuration files and command line arguments.
    It is maintained by Mark McLoughlin.
--  `hacking <https://github.com/openstack-dev/hacking>`_ This enforces
+-  `hacking <http://docs.openstack.org/developer/hacking>`_ This enforces
-   openstack community standards, described
+   openstack community coding style guidelines
-   `here <https://github.com/openstack-dev/hacking/blob/master/HACKING.rst>`_.
 
 General Python/Frameworks
 -------------------------

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