Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Better help text for privacy level #3444

Closed
wants to merge 5 commits into from
Closed

Better help text for privacy level #3444

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9ec46f2
Better help text for privacy level
stsewd Dec 22, 2017
fd8bbab
More consistent help texts
stsewd Dec 22, 2017
0118b01
Fix lint error
stsewd Dec 22, 2017
d5b333b
Remove beta label from privacy help text
stsewd Dec 23, 2017
0d0625f
Add projects migrations
stsewd Dec 23, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 22 additions & 18 deletions readthedocs/projects/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,20 +85,20 @@ class Project(models.Model):
slug = models.SlugField(_('Slug'), max_length=255, unique=True)
description = models.TextField(_('Description'), blank=True,
help_text=_('The reStructuredText '
'description of the project'))
'description of the project.'))
repo = models.CharField(_('Repository URL'), max_length=255,
help_text=_('Hosted documentation repository URL'))
help_text=_('Hosted documentation repository URL.'))
repo_type = models.CharField(_('Repository type'), max_length=10,
choices=constants.REPO_CHOICES, default='git')
project_url = models.URLField(_('Project homepage'), blank=True,
help_text=_('The project\'s homepage'))
help_text=_('The project\'s homepage.'))
canonical_url = models.URLField(_('Canonical URL'), blank=True,
help_text=_('URL that documentation is expected to serve from'))
help_text=_('URL that documentation is expected to serve from.'))
version = models.CharField(_('Version'), max_length=100, blank=True,
help_text=_('Project version these docs apply '
'to, i.e. 1.0a'))
'to, i.e. 1.0a.'))
copyright = models.CharField(_('Copyright'), max_length=255, blank=True,
help_text=_('Project copyright information'))
help_text=_('Project copyright information.'))
theme = models.CharField(
_('Theme'), max_length=20, choices=constants.DEFAULT_THEME_CHOICES,
default=constants.THEME_DEFAULT,
Expand All @@ -114,7 +114,7 @@ class Project(models.Model):
'have multiple versions of your docs.'))
default_version = models.CharField(
_('Default version'), max_length=255, default=LATEST,
help_text=_('The version of your project that / redirects to'))
help_text=_('The version of your project that / redirects to.'))
# In default_branch, None means the backend should choose the
# appropriate branch. Eg 'master' for git
default_branch = models.CharField(
Expand Down Expand Up @@ -151,7 +151,7 @@ class Project(models.Model):
container_mem_limit = models.CharField(
_('Container memory limit'), max_length=10, null=True, blank=True,
help_text=_('Memory limit in Docker format '
'-- example: <code>512m</code> or <code>1g</code>'))
'-- example: <code>512m</code> or <code>1g</code>.'))
container_time_limit = models.CharField(
_('Container time limit'), max_length=10, null=True, blank=True)
build_queue = models.CharField(
Expand All @@ -173,7 +173,7 @@ class Project(models.Model):
# Other model data.
path = models.CharField(_('Path'), max_length=255, editable=False,
help_text=_('The directory where '
'<code>conf.py</code> lives'))
'<code>conf.py</code> lives.'))
conf_py_file = models.CharField(
_('Python configuration file'), max_length=255, default='', blank=True,
help_text=_('Path from project root to <code>conf.py</code> file '
Expand All @@ -185,8 +185,8 @@ class Project(models.Model):
mirror = models.BooleanField(_('Mirror'), default=False)
install_project = models.BooleanField(
_('Install Project'),
help_text=_('Install your project inside a virtualenv using <code>setup.py '
'install</code>'),
help_text=_('Install your project inside a virtualenv using '
'<code>setup.py install</code>.'),
default=False
)

Expand All @@ -211,8 +211,11 @@ class Project(models.Model):
privacy_level = models.CharField(
_('Privacy Level'), max_length=20, choices=constants.PRIVACY_CHOICES,
default=getattr(settings, 'DEFAULT_PRIVACY_LEVEL', 'public'),
help_text=_('(Beta) Level of privacy that you want on the repository. '
'Protected means public but not in listings.'))
help_text=_('(Beta) Level of privacy that you want on the project. '
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here I changed the word repository to project.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe the "Beta" work can be removed since it's not in beta anymore and I understood that you realized that it worked properly but what's is wrong is the docs, right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also think this isn't beta anymore.

'Protected means public but not in listings. Note that '
'the project documentation is still seen by everyone, <a '
'href="http://docs.readthedocs.io/en/latest/privacy.html" '
'target="_blank">more info</a>.'))
version_privacy_level = models.CharField(
_('Version Privacy Level'), max_length=20,
choices=constants.PRIVACY_CHOICES, default=getattr(
Expand Down Expand Up @@ -251,28 +254,29 @@ class Project(models.Model):
default=2,
null=True,
blank=True,
help_text=_('2 means supporting 3.X.X and 2.X.X, but not 1.X.X')
help_text=_('2 means supporting 3.X.X and 2.X.X, but not 1.X.X.')
)
num_minor = models.IntegerField(
_('Number of Minor versions'),
default=2,
null=True,
blank=True,
help_text=_('2 means supporting 2.2.X and 2.1.X, but not 2.0.X')
help_text=_('2 means supporting 2.2.X and 2.1.X, but not 2.0.X.')
)
num_point = models.IntegerField(
_('Number of Point versions'),
default=2,
null=True,
blank=True,
help_text=_('2 means supporting 2.2.2 and 2.2.1, but not 2.2.0')
help_text=_('2 means supporting 2.2.2 and 2.2.1, but not 2.2.0.')
)

has_valid_webhook = models.BooleanField(
default=False, help_text=_('This project has been built with a webhook')
default=False,
help_text=_('This project has been built with a webhook.')
)
has_valid_clone = models.BooleanField(
default=False, help_text=_('This project has been successfully cloned')
default=False, help_text=_('This project has been successfully cloned.')
)

tags = TaggableManager(blank=True)
Expand Down