From d8b4fe4e50dd0b8a6f771d9565f31a36ebbb59e0 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Sun, 14 Oct 2012 12:35:12 -0700 Subject: [PATCH] Add basic docs. --- docs/privacy.rst | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 docs/privacy.rst diff --git a/docs/privacy.rst b/docs/privacy.rst new file mode 100644 index 000000000..831be8da6 --- /dev/null +++ b/docs/privacy.rst @@ -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.