Update docs

Signed-off-by: Chenxiong Qi <qcxhome@gmail.com>

AUTHORS

@@ -1,19 +1,42 @@
-Developers
-==========
+Authors
+=======
 
-- Chaobin Tang <ctang@redhat.com>
-- Chenxiong Qi <cqi@redhat.com>
-- David Malcolm <dmalcolm@redhat.com>
-- Jian Chen <jianchen@redhat.com>
-- June Zhang <junzhang@redhat.com>
-- Lei Xu <lexu@redhat.com>
-- Nan Li <nli@redhat.com>
-- Xiangyang Chu <xchu@redhat.com>
-- Xiaoxue Zhang <xiaoxue@redhat.com>
+Thanks Xuqing Kuang and other original Nitrate team members for creating this
+great software.
 
-Retired developers
-==================
+Maintainers
+-----------
 
-- Xuqing Kuang <xkuang@redhat.com>
+- Chenxiong Qi <qcxhome@gmail.com>
 
-And any others I might have missed here.
+Contributors
+------------
+
+- Andrew Ross
+- Anny Zhang
+- Chaobin Tang
+- Chenxiong Qi
+- David Malcolm
+- Deshi Xiao
+- gj
+- Haibo Lin
+- Jian Chen
+- June Zhang
+- Lei Xu
+- Matthias Cavigelli
+- Mihail Mihaylov
+- Mr. Senko
+- sdeng
+- wangjing
+- weizhou
+- Xiangyang Chu
+- Xiao Deshi
+- Xiaoxue Zhang
+- Xuebin Dong
+- Xuqing Kuang
+- Yuguang Wang
+- Zheng Liu
+- 李楠
+
+Also thanks for anyone else who contributes ideas, suggestions and reports
+bugs.

docs/source/authors.rst

@@ -1,6 +1,3 @@
 .. _authors:
 
-Authors
-=======
-
-.. TODO
+.. include:: ../../AUTHORS

docs/source/conf.py

@@ -112,7 +112,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/source/contact.rst

@@ -0,0 +1,8 @@
+.. _contact:
+
+Contact
+=======
+
+Mailing list: nitrate-devel@lists.fedorahosted.org
+
+IRC: #nitrate at freenode.net

docs/source/index.rst

@@ -15,25 +15,24 @@ Contents
    :maxdepth: 2
    :numbered:
 
-   about.rst
-   set_dev_env.rst
-   set_dev_env_with_vagrant.rst
-   installing_in_rhel.rst
-   installing_in_virtualenv.rst
-   installing_gunicorn.rst
-   installing_gce.rst
-   configuration.rst
-   upgrading.rst
-   tutorial.rst
-   contribution.rst
-   faq.rst
-   bug_reporting.rst
-   xmlrpc-api.rst
-   changelog.rst
-   releasenotes.rst
-   support.rst
-   authors.rst
-   license.rst
+   about
+   set_dev_env
+   set_dev_env_with_vagrant
+   installing_in_rhel
+   installing_in_virtualenv
+   installing_gunicorn
+   installing_gce
+   configuration
+   tutorial
+   contribution
+   faq
+   bug_reporting
+   xmlrpc-api
+   changelog
+   releasenotes
+   contact
+   authors
+   license
 
 Indices and tables
 ------------------

docs/source/set_dev_env.rst

@@ -4,66 +4,65 @@ Setting up a development environment on Fedora
 Get source code
 ---------------
 
-The Nitrate source code is available at: https://github.com/Nitrate/Nitrate
+Nitrate source code is available at: https://github.com/Nitrate/Nitrate
 
 You can get the latest changes with git easily::
 
     git clone https://github.com/Nitrate/Nitrate.git
 
-Setup virtualenv
-----------------
+Create virtualenv
+-----------------
 
-Install devel packages which are needed to compile some of the Python dependencies::
+Install database and devel packages which are required to compile some of the
+Python dependencies::
 
-    sudo yum install gcc python-devel mysql-devel krb5-devel libxml2-devel libxslt-devel
+    sudo dnf install gcc python-devel mariadb mariadb-devel krb5-devel \
+        libxml2-devel libxslt-devel
 
-Create a virtual environment for Nitrate::
+Create a virtual environment::
 
     virtualenv ~/virtualenvs/nitrate
 
-Install dependencies from ``requirements/devel.txt``::
+Install dependencies::
 
     . ~/virtualenvs/nitrate/bin/activate
     pip install -r requirements/devel.txt
 
+.. note:: 
+
+    ``devel.txt`` has the link to ``base.txt`` which includes required Python
+    packages for running Nitrate.
+
 Initialize database
 -------------------
 
-Currently, MySQL is only be supported, either mysql or mariadb is okay for
-running Nitrate.
-
-Create database and user::
+Create database::
 
     mysql -uroot
     create database nitrate character set utf8;
-    GRANT all privileges on nitrate.* to nitrate@'%' identified by 'nitrate';
 
 For convenience for development, user, password and database name are already
-set in `tcms/settings/devel.py` with default value. Each of them is `nirrate`.
+set in ``tcms/settings/devel.py`` with default value.
 
 .. note::
 
     You may want to adjust the database and/or other configuration settings.
-    Override them in ``./tcms/settings/devel.py`` if necessary. While the
-    Nitrate team prefers MySQL, sqlite appears to work for development
-    and some people have used PostgreSQL with varying success in production!
-    At the moment Nitrate is not 100% portable between database backends
-    due to some hard-coded SQL statements. If you use something other than MySQL
-    some parts of the application may not work correctly!
-
-.. warning::
-
-    Do not commit local development overrides to GitHub!
+    Override them in ``./tcms/settings/devel.py`` if necessary. While MariaDB
+    is supported currently, sqlite appears to work for development and some
+    people have used PostgreSQL with varying success in production! At the
+    moment Nitrate is not 100% portable between database backends due to some
+    hard-coded SQL statements. If you use something other than MariaDB some
+    parts of the application may not work correctly!
 
 Load database schema and initial data::
 
     ./manage.py migrate
 
-Let's run Nitrate
------------------
+Final Step
+----------
 
-You're now ready to start the server::
+Nitrate is ready to run::
 
     ./manage.py runserver
 
-Now, open http://127.0.0.1:8000/ and should be presented with your brand new Nitrate homepage!
+Open http://127.0.0.1:8000/ and there should be brand new Nitrate homepage!