Add basic docs.

rtd2
Eric Holscher 2012-10-14 12:35:12 -07:00
parent 011f64569c
commit d8b4fe4e50
1 changed files with 36 additions and 0 deletions

36
docs/privacy.rst Normal file
View File

@ -0,0 +1,36 @@
Privacy Levels
==============
Read the Docs supports 3 different privacy levels on 2 different objects;
Public, Protected, Private on Projects and Versions.
+------------+------------+-----------+
| Viewable | Detail | Listing |
+============+============+===========+
| Private | No | No |
+------------+------------+-----------+
| Protected | Yes | No |
+------------+------------+-----------+
| Public | Yes | No |
+------------+------------+-----------+
Public
------
This is the easiest and most obvious. It is also the default. It means that everything is available to be seen by everyone.
Protected
---------
Protected means that your object won't show up in Listing Pages, but Detail pages still still work.
For example, a Project that is Protected will not show on the homepage Recently Updated list,
however, if you link directly to the project, you will get a 200 and the page will display.
Protected Versions are similar, they won't show up in your version listings, but will be available once linked to.
Private
-------
Private objects are available only to people who have permissions so see them.
They will not display on any list view, and will 404 when you link them to others.