refactor(docs): move from reST to Markdown (#776)

Convert docs from reStructuredText to Markdown so that the changelog
file is compatible with Release Please.

AUTHORS.md

@@ -0,0 +1,30 @@
+# Authors
+
+The list of contributors in alphabetical order:
+
+- [Adelina Lintuluoto](https://orcid.org/0000-0002-0726-1452)
+- [Anton Khodak](https://orcid.org/0000-0003-3263-4553)
+- [Audrius Mecionis](https://orcid.org/0000-0002-3759-1663)
+- [Camila Diaz](https://orcid.org/0000-0001-5543-797X)
+- [Daan Rosendal](https://github.com/DaanRosendal)
+- [Dan Leehr](https://orcid.org/0000-0003-3221-9579)
+- [Daniel Prelipcean](https://orcid.org/0000-0002-4855-194X)
+- [Diego Rodriguez](https://orcid.org/0000-0003-0649-2002)
+- [Dinos Kousidis](https://orcid.org/0000-0002-4914-4289)
+- [Domenic Gosein](https://orcid.org/0000-0002-1546-0435)
+- [Harri Hirvonsalo](https://orcid.org/0000-0002-5503-510X)
+- [Jan Okraska](https://orcid.org/0000-0002-1416-3244)
+- [Kenyi Hurtado-Anampa](https://orcid.org/0000-0002-9779-3566)
+- [Leticia Wanderley](https://orcid.org/0000-0003-4649-6630)
+- [Lukas Heinrich](https://orcid.org/0000-0002-4048-7584)
+- [Marco Donadoni](https://orcid.org/0000-0003-2922-5505)
+- [Marco Vidal](https://orcid.org/0000-0002-9363-4971)
+- [Matthew Feickert](https://orcid.org/0000-0003-4124-7862)
+- [Michael R. Crusoe](https://orcid.org/0000-0002-2961-9670)
+- [Robin Long](https://github.com/longr)
+- [Rokas Maciulaitis](https://orcid.org/0000-0003-1064-6967)
+- [Ronald Dobos](https://orcid.org/0000-0003-2914-000X)
+- [Sasha Baranov](https://github.com/sashabaranov)
+- [Sinclert Perez](https://www.linkedin.com/in/sinclert)
+- [Tibor Simko](https://orcid.org/0000-0001-7202-5803)
+- [Vladyslav Moisieienkov](https://orcid.org/0000-0001-9717-0775)

CONTRIBUTING.rst → CONTRIBUTING.md

@@ -1,24 +1,20 @@
-Contributing
-============
+# Contributing
 
-Issues
-------
+## Issues
 
 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
-   <https://github.com/search?q=org%3Areanahub+is%3Aissue+is%3Aopen>`_.
+1. Search for [already reported problems](https://github.com/search?q=org%3Areanahub+is%3Aissue+is%3Aopen).
 2. Check if the issue has been fixed or is still reproducible on the
    latest `master` branch.
 3. Create an issue, ideally with **a test case**.
 
 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
+```console
+$ ./run-tests.sh
+```
 
 Each pull request should preserve or increase code coverage.
-

MANIFEST.in

@@ -7,7 +7,6 @@
 include *.html
 include *.json
 include *.md
-include *.rst
 include *.sh
 include *.yaml
 include *.yml
@@ -19,7 +18,7 @@ prune docs/_build
 recursive-include reana *.py
 recursive-include docs *.py
 recursive-include docs *.png
-recursive-include docs *.rst
+recursive-include docs *.md
 recursive-include docs *.txt
 recursive-include tests *.py
 recursive-include helm *.yaml

README.md

@@ -0,0 +1,54 @@
+[![image](docs/logo-reana.png)](http://docs.reana.io)
+
+# REANA - Reusable Analyses
+
+[![image](https://github.com/reanahub/reana/workflows/CI/badge.svg)](https://github.com/reanahub/reana/actions)
+[![image](https://readthedocs.org/projects/reana/badge/?version=latest)](https://reana.readthedocs.io/en/latest/?badge=latest)
+[![image](https://codecov.io/gh/reanahub/reana/branch/master/graph/badge.svg)](https://codecov.io/gh/reanahub/reana)
+[![image](https://img.shields.io/badge/discourse-forum-blue.svg)](https://forum.reana.io)
+[![image](https://img.shields.io/github/license/reanahub/reana.svg)](https://github.com/reanahub/reana/blob/master/LICENSE)
+[![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+## About
+
+[REANA](http://www.reana.io) is a reusable and reproducible research data analysis
+platform. It helps researchers to structure their input data, analysis code,
+containerised environments and computational workflows so that the analysis can be
+instantiated and run on remote compute clouds.
+
+REANA was born to target the use case of particle physics analyses, but is applicable to
+any scientific discipline. The system paves the way towards reusing and reinterpreting
+preserved data analyses even several years after the original publication.
+
+## Features
+
+- structure research data analysis in reusable manner
+- instantiate computational workflows on remote clouds
+- rerun analyses with modified input data, parameters or code
+- support for several compute clouds (Kubernetes/OpenStack)
+- support for several workflow specifications (CWL, Serial, Yadage, Snakemake)
+- support for several shared storage systems (Ceph)
+- support for several container technologies (Docker)
+
+## Getting started
+
+You can
+[install REANA locally](https://docs.reana.io/administration/deployment/deploying-locally/),
+[deploy it at scale on premises](https://docs.reana.io/administration/deployment/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](https://docs.reana.io/getting-started/first-example/). For more in
+depth information visit the [official REANA documentation](https://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/)

docs/conf.py

@@ -40,6 +40,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    "myst_parser",
     "sphinx.ext.autodoc",
     "sphinx.ext.coverage",
     "sphinx.ext.doctest",
@@ -55,14 +56,17 @@
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = ".rst"
+source_suffix = [".rst", ".md"]
+
+# Allow using ::: in Markdown files
+myst_enable_extensions = ["colon_fence"]
 
 # The master toctree document.
 master_doc = "index"
 
 # General information about the project.
 project = "reana"
-copyright = "2017-2023 info@reana.io"
+copyright = "2017-2024, info@reana.io"
 author = "info@reana.io"
 
 # The version info for the project you're documenting, acts as replacement for

docs/index.md

@@ -0,0 +1,3 @@
+# REANA
+
+REANA documentation has been moved, please visit our new documentation website [docs.reana.io](https://docs.reana.io).

setup.py

@@ -14,15 +14,16 @@
 
 from setuptools import find_packages, setup
 
-readme = open("README.rst").read()
-history = open("CHANGES.rst").read()
+readme = open("README.md").read()
+history = open("CHANGELOG.md").read()
 
 tests_require = [
     "pytest-reana>=0.9.2,<0.10.0",
 ]
 
 extras_require = {
     "docs": [
+        "myst-parser",
         "Sphinx>=1.5.1",
     ],
     "tests": tests_require,
@@ -66,6 +67,7 @@
     version=version,
     description=__doc__,
     long_description=readme + "\n\n" + history,
+    long_description_content_type="text/markdown",
     author="REANA",
     author_email="info@reana.io",
     url="http://www.reana.io/",