Skip to content

Commit

Permalink
Merge pull request #3472 from rtfd/humitos/docs/improve-sharing
Browse files Browse the repository at this point in the history
Improve "Sharing" docs
  • Loading branch information
humitos authored Mar 15, 2018
2 parents 74bbb3a + d2d4a1e commit 1db9bbd
Showing 1 changed file with 23 additions and 10 deletions.
33 changes: 23 additions & 10 deletions docs/business/sharing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,39 @@ Sharing
.. note:: This feature only exists on our Business offering at `readthedocs.com <https://readthedocs.com/>`_.

You can share your project with users outside of your company.
This works by sending them a link,
which will allow them to view a specific project inside your company.
There are two way to do this:

* by sending them a *secret link*,
* by giving them a *password*.

These methods will allow them to view a specific project inside your company.

Enabling
~~~~~~~~

* Go into your *Project Admin* page and to the *Sharing* link.
* Under the *Add Token* heading, add a *Description* so you remember who you're sharing it with.
* Click *Share* to create.
* Copy the link that is generated, and give that to the person who you want to give access.
* Go into your *Project Admin* page and to the *Sharing* menu.
* Under the *Share with someone new* heading, select the way you prefer (secret link or password), add an expiration date and a *Description* so you remember who you're sharing it with.
* Click *Share!* to create.
* Get the info needed to share your documentation with other users:
* If you have selected secret link, copy the link that is generated
* In case of password, copy the link and password
* Give that information to the person who you want to give access.

.. note:: You can always revoke access in the same panel.

Effects
~~~~~~~

Secret Link
***********

Once the person you send the link to clicks the link,
they will have access to view your project.
It will only work for the specific browser that they click the link from.

.. warning:: They will be able to share this token with other people,
so only share with people you trust.
We only let sharing links be activated **five** times to prevent abuse.
Password
********

Once the person you send the link to clicks on the link, they will see
a *Authorization required* page asking them for the password you
generated. When the user enters the password, they will have access to
view your project.

0 comments on commit 1db9bbd

Please sign in to comment.