Skip to content

Commit 3d9992c

Browse files
committed
Hide "Protected" privacy level from users
Protected causes a lot of confusions to users. I'm hiding it for now as a temporarily solution while we implement more Version states and this behavior can be easily managed. See #5321
1 parent 5bdb2f8 commit 3d9992c

File tree

3 files changed

+6
-18
lines changed

3 files changed

+6
-18
lines changed

docs/privacy.rst

+1-15
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Privacy Levels
22
==============
33

44
Read the Docs supports 3 different privacy levels on 2 different objects;
5-
Public, Protected, Private on Projects and Versions.
5+
Public, Private on Projects and Versions.
66

77
Understanding the Privacy Levels
88
--------------------------------
@@ -12,8 +12,6 @@ Understanding the Privacy Levels
1212
+============+============+===========+===========+=============+
1313
| Private | No | No | No | Yes |
1414
+------------+------------+-----------+-----------+-------------+
15-
| Protected | Yes | No | No | Yes |
16-
+------------+------------+-----------+-----------+-------------+
1715
| Public | Yes | Yes | Yes | Yes |
1816
+------------+------------+-----------+-----------+-------------+
1917

@@ -27,18 +25,6 @@ Public
2725
This is the easiest and most obvious. It is also the default.
2826
It means that everything is available to be seen by everyone.
2927

30-
Protected
31-
~~~~~~~~~
32-
33-
Protected means that your object won't show up in Listing Pages,
34-
but Detail pages still work. For example, a Project that is Protected will
35-
not show on the homepage Recently Updated list, however,
36-
if you link directly to the project, you will get a 200 and the page will display.
37-
38-
Protected Versions are similar, they won't show up in your version listings,
39-
but will be available once linked to.
40-
41-
4228
Private
4329
~~~~~~~
4430

readthedocs/projects/constants.py

+4-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,10 @@
8080

8181
PRIVACY_CHOICES = (
8282
(PUBLIC, _('Public')),
83-
(PROTECTED, _('Protected')),
83+
# Remove Protected for now since it cause confusions to users.
84+
# There is a better way to manage this by using Version states
85+
# See: https://github.com/rtfd/readthedocs.org/issues/5321
86+
# (PROTECTED, _('Protected')),
8487
(PRIVATE, _('Private')),
8588
)
8689

readthedocs/projects/models.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -329,8 +329,7 @@ class Project(models.Model):
329329
choices=constants.PRIVACY_CHOICES,
330330
default=settings.DEFAULT_PRIVACY_LEVEL,
331331
help_text=_(
332-
'Level of privacy that you want on the repository. '
333-
'Protected means public but not in listings.',
332+
'Level of privacy that you want on the repository.',
334333
),
335334
)
336335
version_privacy_level = models.CharField(

0 commit comments

Comments
 (0)