docs: better structure

* Enhances documentation structure, updates author list, updates short description and feature list. Signed-off-by: Tibor Simko <[email protected]>
mdonadoni · Jan 25, 2018 · eada161 · eada161
1 parent 719cc25
commit eada161
Show file tree

Hide file tree

Showing 11 changed files with 48 additions and 43 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -1,7 +1,8 @@
 Authors
 =======
 
-* Diego Rodriguez <[email protected]>
-* Jiri Kuncar <[email protected]>
-* Lukas Heinrich <[email protected]>
-* Tibor Simko <[email protected]>
+The list of contributors in alphabetical order:
+
+- Anton Khodak <[email protected]>
+- Diego Rodriguez <[email protected]>
+- Tibor Simko <[email protected]>
diff --git a/README.rst b/README.rst
@@ -20,4 +20,26 @@
 .. image:: https://img.shields.io/github/license/reanahub/reana-job-controller.svg
    :target: https://github.com/reanahub/reana-job-controller/blob/master/COPYING
 
-The job controller component of the REANA system.
+About
+-----
+
+REANA-Job-Controller is a component of the `REANA <http://reanahub.io/>`_
+reusable analysis platform. It takes care of executing and managing jobs on
+compute clouds.
+
+Features
+--------
+
+- submit jobs to compute cloud
+- enquire about status of running jobs
+
+Useful links
+------------
+
+- `documentation <https://reana-job-controller.readthedocs.io/>`_
+- `releases <https://github.com/reanahub/reana-job-controller/releases>`_
+- `known issues <https://github.com/reanahub/reana-job-controller/issues>`_
+- `source code <https://github.com/reanahub/reana-job-controller>`_
+
+For more information about the REANA reusable analysis platform, please see the
+general `REANA documentation <http://reana.readthedocs.io/>`_.
diff --git a/docs/authors.rst b/docs/authors.rst
@@ -1 +1,3 @@
+.. _authors:
+
 .. include:: ../AUTHORS.rst
diff --git a/docs/changes.rst b/docs/changes.rst
@@ -1 +1,3 @@
+.. _changes:
+
 .. include:: ../CHANGES.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -119,7 +119,7 @@
 #
 html_theme_options = {
     'logo': 'logo-reana.png',
-    'description': 'REANA Job Controller',
+    'description': 'REANA-Job-Controller',
     'github_user': 'reanahub',
     'github_repo': 'reana-job-controller',
     'github_button': False,

diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -1 +1,3 @@
+.. _contributing:
+
 .. include:: ../CONTRIBUTING.rst
diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,11 +1,14 @@
 .. include:: ../README.rst
+   :end-before: About
+
+.. include:: ../README.rst
+   :start-after: -----
+   :end-before: Features
 
 .. toctree::
    :numbered:
-   :maxdepth: 2
 
    introduction
-   gettingstarted
    restapi
    contributing
    changes

diff --git a/docs/introduction.rst b/docs/introduction.rst
@@ -1,16 +1,7 @@
+.. _introduction:
+
 Introduction
 ============
 
-About
------
-
-REANA-Job-Controller is a component of the `REANA <http://reanahub.io/>`_
-system. It takes care of job execution and management. Please see the `general
-REANA documentation <http://reana.readthedocs.io/>`_ if you would like to know
-more about the use of this component within the wider REANA framework.
-
-Features
---------
-
-- submit jobs to computing cloud
-- get information about running jobs on the computing cloud
+.. include:: ../README.rst
+   :start-line: 22
diff --git a/docs/license.rst b/docs/license.rst
@@ -1,3 +1,5 @@
+.. _license:
+
 License
 =======
 

diff --git a/docs/restapi.rst b/docs/restapi.rst
@@ -1,3 +1,5 @@
+.. _restapi:
+
 REST API
 ========