Merge 93b7b9b into ef03f5d

reanahub · Jan 26, 2018 · 4677ea4 · 4677ea4
2 parents ef03f5d + 93b7b9b
commit 4677ea4
Show file tree

Hide file tree

Showing 10 changed files with 45 additions and 25 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -1,7 +1,8 @@
 Authors
 =======
 
+The list of contributors in alphabetical order:
+
 * Diego Rodriguez <diego.rodriguez@cern.ch>
-* Jiri Kuncar <jiri.kuncar@cern.ch>
 * Lukas Heinrich <lukas.heinrich@gmail.com>
 * Tibor Simko <tibor.simko@cern.ch>
diff --git a/README.rst b/README.rst
@@ -20,4 +20,27 @@
 .. image:: https://img.shields.io/github/license/reanahub/reana-workflow-engine-yadage.svg
       :target: https://github.com/reanahub/reana-workflow-engine-yadage/blob/master/COPYING
 
-The workflow engine yadage component of the REANA system.
+About
+-----
+
+REANA-Workflow-Engine-Yadage is a component of the `REANA
+<http://reanahub.io/>`_ reusable analysis platform. It takes care of
+instantiating, executing and managing `Yadage
+<https://github.com/diana-hep/yadage>`_ based computational workflows.
+
+Features
+--------
+
+- start Yadage workflows
+- control workflow steps
+
+Useful links
+------------
+
+- `documentation <https://reana-workflow-engine-yadage.readthedocs.io/>`_
+- `releases <https://github.com/reanahub/reana-workflow-engine-yadage/releases>`_
+- `known issues <https://github.com/reanahub/reana-workflow-engine-yadage/issues>`_
+- `source code <https://github.com/reanahub/reana-workflow-engine-yadage>`_
+
+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
@@ -62,7 +62,7 @@
 
 # General information about the project.
 project = 'reana'
-copyright = '2017, info@reana.io'
+copyright = '2017, 2018, info@reana.io'
 author = 'info@reana.io'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -112,7 +112,7 @@
 #
 html_theme_options = {
     'logo': 'logo-reana.png',
-    'description': 'REANA Workflow Engine Yadage',
+    'description': 'REANA-Workflow-Engine-Yadage',
     'github_user': 'reanahub',
     'github_repo': 'reana-workflow-engine-yadage',
     '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
    contributing
    changes
    license

diff --git a/docs/introduction.rst b/docs/introduction.rst
@@ -1,18 +1,7 @@
+.. _introduction:
+
 Introduction
 ============
 
-About
------
-
-REANA-Workflow-Engine-Yadage is a component of the `REANA
-<http://reanahub.io/>`_ system. It takes care of instantiating and managing
-`Yadage <https://github.com/diana-hep/yadage>`_ workflows. 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
---------
-
-- start workflows
-- control workflow steps
-- support for `Yadage <https://github.com/diana-hep/yadage>`_ workflows
+.. include:: ../README.rst
+   :start-line: 22
diff --git a/docs/license.rst b/docs/license.rst
@@ -1,3 +1,5 @@
+.. _license:
+
 License
 =======