Skip to content

Commit

Permalink
docs: move to docs.reana.io enrich README
Browse files Browse the repository at this point in the history
* Closes #355.
  • Loading branch information
Diego Rodriguez committed Aug 7, 2020
1 parent 8bbd737 commit 0f8c0c6
Show file tree
Hide file tree
Showing 25 changed files with 31 additions and 1,312 deletions.
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,6 @@ coverage.xml
# Django stuff:
*.log

# Sphinx documentation
docs/_build/

# PyBuilder
target/

Expand Down
15 changes: 3 additions & 12 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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".
7 changes: 1 addition & 6 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,14 @@ include *.md
include *.html
include *.sh
include pytest.ini
prune docs/_build
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
recursive-include helm *.helmignore
recursive-include helm *.lock
recursive-include benchmark *.py
recursive-include scripts *.sh
recursive-include images *.png

# Helm
recursive-include helm *.md
Expand Down
4 changes: 1 addition & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -234,10 +234,8 @@ 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-*"
sphinx-build -qnNW docs docs/_build/html
check-manifest
python setup.py test
sphinx-build -qnNW -b doctest docs docs/_build/doctest
helm lint helm/reana

# end of file
23 changes: 20 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
.. image:: images/logo-reana.png
:target: http://docs.reana.io
:align: center

===========================
REANA - Reusable Analyses
===========================
Expand Down Expand Up @@ -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>`_
Binary file removed docs/_static/reana-architecture.png
Binary file not shown.
Binary file removed docs/_static/setting-the-breakpoint.png
Binary file not shown.
Binary file removed docs/_static/wdb-active-sessions.png
Binary file not shown.
Binary file removed docs/_static/wdb-debugging-ui.png
Binary file not shown.
179 changes: 0 additions & 179 deletions docs/administratorguide.rst

This file was deleted.

3 changes: 0 additions & 3 deletions docs/authors.rst

This file was deleted.

3 changes: 0 additions & 3 deletions docs/changes.rst

This file was deleted.

0 comments on commit 0f8c0c6

Please sign in to comment.