Skip to content

Add a banner line for latest hints #6143

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

Closed
wants to merge 9 commits into from
Closed

Add a banner line for latest hints #6143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2b1ccab
Add a banner line for latest hints
tapaswenipathak Sep 6, 2019
3db5d3f
Add proper warning message
tapaswenipathak Sep 9, 2019
9615df9
fix wording
tapaswenipathak Sep 9, 2019
f088775
merge commit
tapaswenipathak Oct 15, 2019
0ea6e39
add banner for unstable documentation
tapaswenipathak Oct 15, 2019
4919254
text fixes
tapaswenipathak Oct 16, 2019
90a0890
banner text for unstable documentation
tapaswenipathak Oct 16, 2019
4f7b86e
travis fixes
tapaswenipathak Oct 17, 2019
1184582
address review
tapaswenipathak Oct 17, 2019
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
2 changes: 1 addition & 1 deletion docs/versions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Version warning
---------------

This is a banner that appears on the top of every page of your docs that aren't stable or latest.
This banner has a text with a link redirecting the users to the latest version of your docs.
This banner has a text with a link redirecting the users to the stable version of your docs.
Copy link
Member

Choose a reason for hiding this comment

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

This may still be confusing. I'd like to say something like

Suggested change
This banner has a text with a link redirecting the users to the stable version of your docs.
This banner has a text with a link redirecting the users to the latest stable version of your docs.

but with a clearer English sentence.

Copy link
Member

Choose a reason for hiding this comment

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

Mmm... does the banner links to v0.x or to stable?

Copy link
Member

Choose a reason for hiding this comment

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

We only have one stable version, there isn't something like latest stable.

Copy link
Member

Choose a reason for hiding this comment

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

I realized that and that's why my second question.


This feature is disabled by default on new projects,
you can enable it in the admin section of your docs (:guilabel:`Admin` > :guilabel:`Advanced Settings`).
20 changes: 20 additions & 0 deletions readthedocs/projects/migrations/0045_update-show-version-warning-help-text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# -*- coding: utf-8 -*-
# Generated by Django 1.11.25 on 2019-10-17 15:58
from __future__ import unicode_literals

from django.db import migrations, models


class Migration(migrations.Migration):

dependencies = [
('projects', '0044_auto_20190703_1300'),
]

operations = [
migrations.AlterField(
model_name='project',
name='show_version_warning',
field=models.BooleanField(default=False, help_text='Show a warning banner with a link to the stable version on not stable versions, except for latest.', verbose_name='Show version warning'),
),
]
5 changes: 4 additions & 1 deletion readthedocs/projects/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,10 @@ class Project(models.Model):
show_version_warning = models.BooleanField(
_('Show version warning'),
default=False,
help_text=_('Show warning banner in non-stable nor latest versions.'),
help_text=_(
'Show a warning banner with a link to the stable version on not'
' stable versions, except for latest.'
Comment on lines +255 to +256
Copy link
Member

Choose a reason for hiding this comment

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

Here also. I'd like to improve this sentence. It's really hard to parse and understand the last part: "the stable version on not stable versions, except for latest.". After reading it three times I think I understand what it means, but it was hard to get it.

Maybe splitting it in multiple sentences like:

Show a warning banner with a link to the stable version.
The banner is shown in all the versions, but in latest and stable.

),
)

# Sphinx specific build options.
Expand Down