docs: move to docs.reana.io enrich README

* Closes reanahub#355.
mdonadoni · Aug 7, 2020 · 9abd6ff · 9abd6ff
1 parent 8bbd737
commit 9abd6ff
Show file tree

Hide file tree

Showing 23 changed files with 36 additions and 1,117 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -4,7 +4,7 @@ Contributing
 Issues
 ------
 
-Bug reports, feature requests, and other contributions are welcome. If you find
+Bug reports, issues, feature requests, and other contributions are welcome. If you find
 a demonstrable problem that is caused by the REANA code, please:
 
 1. Search for `already reported problems
@@ -13,21 +13,12 @@ a demonstrable problem that is caused by the REANA code, please:
    latest `master` branch.
 3. Create an issue, ideally with **a test case**.
 
-Pull requests
--------------
-
-If you create a feature branch, you can run the tests to ensure that everything
-is operating correctly:
+If you create a pull request fixing a bug or implementing a feature, you can run
+the tests to ensure that everything is operating correctly:
 
 .. code-block:: console
 
     $ ./run-tests.sh
 
 Each pull request should preserve or increase code coverage.
 
-Kanban
-------
-
-We are using Kanban technique for keeping track of ongoing tasks. Please see our
-`Kanban board <https://waffle.io/reanahub/reana>`_ and look for issues that are
-labelled as "ready for work".
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -16,7 +16,6 @@ recursive-include reana *.py
 recursive-include docs *.py
 recursive-include docs *.png
 recursive-include docs *.rst
-recursive-include docs *.txt
 recursive-include tests *.py
 recursive-include helm *.yaml
 recursive-include helm *.txt

diff --git a/Makefile b/Makefile
@@ -234,7 +234,7 @@ teardown: # Destroy local host virtual environment and Minikube. All traces go.
 test: # Run unit tests on the REANA package.
 	pydocstyle reana
 	black --check .
-	check-manifest --ignore ".travis-*"
+	check-manifest
 	sphinx-build -qnNW docs docs/_build/html
 	python setup.py test
 	sphinx-build -qnNW -b doctest docs docs/_build/doctest

diff --git a/README.rst b/README.rst
@@ -1,3 +1,7 @@
+.. image:: docs/logo-reana.png
+   :target: http://docs.reana.io
+   :align: center
+
 ===========================
  REANA - Reusable Analyses
 ===========================
@@ -44,11 +48,24 @@ Features
 - support for several shared storage systems (Ceph)
 - support for several container technologies (Docker)
 
+Getting started
+---------------
+
+You can `install REANA locally <http://docs.reana.io/development/deploying-locally/>`_, `deploy it at scale on premises
+<http://docs.reana.io/development/deploying-at-scale/>`_ (in about 10 minutes) or use https://reana.cern.ch. Once the system
+is ready, you can follow the guide to run `your first example <http://docs.reana.io/getting-started/first-example/>`_.
+For more in depth information visit the `official REANA documentation <http://docs.reana.io/>`_.
+
+Community
+---------
+
+- Discuss `on Forum <https://forum.reana.io/>`_
+- Chat on `Mattermost <https://mattermost.web.cern.ch/it-dep/channels/reana>`_ or `Gitter <https://gitter.im/reanahub/reana>`_
+- Follow us `on Twitter <https://twitter.com/reanahub>`_
+
 Useful links
 ------------
 
 - `REANA home page <http://www.reana.io/>`_
+- `REANA documentation <http://docs.reana.io/>`_
 - `REANA on DockerHub <https://hub.docker.com/u/reanahub/>`_
-- `REANA on GitHub <https://github.com/reanahub/>`_
-- `REANA on ReadTheDocs <https://reana.readthedocs.io/>`_
-- `REANA on Twitter <https://twitter.com/reanahub>`_
diff --git a/docs/_static/reana-architecture.png b/docs/_static/reana-architecture.png
diff --git a/docs/_static/setting-the-breakpoint.png b/docs/_static/setting-the-breakpoint.png
diff --git a/docs/_static/wdb-active-sessions.png b/docs/_static/wdb-active-sessions.png
diff --git a/docs/_static/wdb-debugging-ui.png b/docs/_static/wdb-debugging-ui.png
diff --git a/docs/administratorguide.rst b/docs/administratorguide.rst
diff --git a/docs/authors.rst b/docs/authors.rst
diff --git a/docs/changes.rst b/docs/changes.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -46,8 +46,6 @@
     "sphinx.ext.graphviz",
     "sphinx.ext.intersphinx",
     "sphinx.ext.viewcode",
-    "sphinx_click.ext",
-    "sphinxcontrib.programoutput",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -64,7 +62,7 @@
 
 # General information about the project.
 project = "reana"
-copyright = "2017, 2018, 2019, info@reana.io"
+copyright = "2017-2020 info@reana.io"
 author = "info@reana.io"
 
 # The version info for the project you're documenting, acts as replacement for
@@ -122,30 +120,9 @@
     "github_user": "reanahub",
     "github_repo": "reana",
     "github_button": False,
-    "github_banner": True,
+    "github_banner": False,
     "show_powered_by": False,
-    "extra_nav_links": {
-        "REANA@DockerHub": "https://hub.docker.com/u/reanahub/",
-        "REANA@GitHub": "https://github.com/reanahub",
-        "REANA@Twitter": "https://twitter.com/reanahub",
-        "REANA@Web": "http://www.reana.io",
-    },
-}
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
-
-# Custom sidebar templates, maps document names to template names.
-html_sidebars = {
-    "**": [
-        "about.html",
-        "navigation.html",
-        "relations.html",
-        "searchbox.html",
-        "donate.html",
-    ]
+    "nosidebar": True,
 }
 
 # -- Options for HTMLHelp output ------------------------------------------

diff --git a/docs/contributing.rst b/docs/contributing.rst