Skip to content

Commit

Permalink
Merge pull request #2085 from antgonza/sharing-help
Browse files Browse the repository at this point in the history
adding share documentation
  • Loading branch information
josenavas committed Mar 3, 2017
2 parents cf801a4 + aeeac62 commit 2795046
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 1 deletion.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions qiita_pet/support_files/doc/source/tutorials/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ The following is a full list of the available tutorials:
prepare-information-files
ebi-submission
getting-started
sharing
analyze-data
no-raw-sequences
join-paired-end-reads
Expand Down
51 changes: 51 additions & 0 deletions qiita_pet/support_files/doc/source/tutorials/sharing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
.. _sharing:

.. index:: sharing

.. role:: red

Study and analysis sharing
==========================

.. note::
You can only share studies and analysis with registered users via their
email.

Qiita allows users to share their own Studies (owner, the User that created the
study) and Analysis with the goal of encourage online collaboration. When a
study or analysis are shared the invited User inherits the same rights and
permissions that the owner of the Study has. These permissions are:

- Add, download and process any Qiita artifact. Most recently, this also
includes the ability to download the raw sequence data added to each of the
preparations. This feature is turned off for any public datasets for
security reasons.
- Create, modify and delete the sample information. file
- Create, modify and delete any preparation information file


Sharing a Study
---------------

In the “Your Studies (includes shared with you)” section of the Studies List
you have a “Shared With These Users” column that lists all User names that
your study is shared with. You can click on the “Modify” button and add/remove
users. See below.

.. figure:: images/sharing_study.gif
:align: center

Study sharing example


Sharing an Analysis
-------------------

Analysis sharing allows full access to the Analysis, including downloading the
files generated or deleting it. In the main display page of the Analysis you
will have a link to share it. See below

.. figure:: images/sharing_study.gif
:align: center

Analysis sharing example
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
]},
scripts=glob('scripts/*'),
extras_require={'test': ["nose >= 0.10.1", "pep8", 'mock']},
install_requires=['psycopg2', 'click >= 3.3', 'future',
install_requires=['psycopg2 < 2.7', 'click >= 3.3', 'future',
'bcrypt', 'pandas >= 0.17', 'numpy >= 1.7',
'tornado==3.1.1', 'toredis', 'redis', 'six',
'ipython[all] >= 2.4.1, < 2.5', 'pyparsing',
Expand Down

0 comments on commit 2795046

Please sign in to comment.