Add a banner line for latest hints #6143

tapaswenipathak · 2019-09-06T14:53:37Z

arron-tij · 2019-09-07T07:12:53Z

Wouldn't it be less redundant and more crisp if it just stated
This banner has a text with a link redirecting the users to the latest stable version of your docs.
Also I think it doesn't fix the second part of the issue. Should I go ahead and make another PR @stsewd or this issue has already been assigned?
(Sorry if i am mistaken somewhere I am new to open source)

tapaswenipathak · 2019-09-07T07:22:39Z

@arron-tij: Suggestion - always write notes on ticket, never spam or write notes on any PRs if you aren't a maintainer. Feel free writing a PR, nothing is assigned, I just felt like closing that tiny issue out.

stsewd

You should update this help text too

readthedocs.org/readthedocs/projects/models.py

Line 254 in 98a7ff1

help_text=_('Show warning banner in non-stable nor latest versions.'),

docs/versions.rst

stsewd · 2019-09-09T16:05:23Z

@arron-tij we don't assign issues, but if there is an open PR, that means someone else is working on that issue. You can take the work if the PR is stale and the author hasn't update it in a long time.

Feel free to ask questions on our gitter channel https://gitter.im/rtfd/readthedocs.org

tapaswenipathak · 2019-09-09T22:09:13Z

@stsewd: Please see now.

Co-Authored-By: Santos Gallegos <[email protected]>

readthedocs/projects/models.py

tapaswenipathak · 2019-10-15T14:28:25Z

@stsewd: review ping.

stsewd · 2019-10-15T14:51:45Z

readthedocs/projects/migrations/0024_add-show-version-warning.py

@@ -15,7 +15,7 @@ class Migration(migrations.Migration):
        migrations.AddField(
            model_name='project',
            name='show_version_warning',
-            field=models.BooleanField(default=False, help_text='Show warning banner in non-stable nor latest versions.', verbose_name='Show version warning'),
+            field=models.URLField(blank=True, help_text='You are seeing unstable version of the documentation, see the stable versions.', verbose_name='Show version warning'),


There is not need to change the field type. Also, the text doesn't match the usage of this field.

I don't know what you are saying. How do you think you will have a link shown in the banner?

stsewd · 2019-10-15T14:52:06Z

readthedocs/projects/models.py

-        default=False,
-        help_text=_('Show warning banner in non-stable nor latest versions.'),
+        blank=True,
+        help_text=_('You are seeing unstable version of the documentation, see the stable versions.'),


Same, you shouldn't change the defaults

tapaswenipathak · 2019-10-16T06:08:16Z

@stsewd: I did few text fixes, lemme know.

stsewd · 2019-10-16T14:53:36Z

@tapaswenipathak you only neeed to change the help text, not the field type of the models

tapaswenipathak · 2019-10-16T16:04:40Z

@stsewd: Can you tell me the correct text? Ref: #6143 (comment).

stsewd · 2019-10-16T21:31:32Z

Something like

Show a warning banner with a link to the stable version on not stable versions, except for latest

tapaswenipathak · 2019-10-17T02:42:34Z

@stsewd: review ping.

readthedocs/projects/migrations/0024_add-show-version-warning.py

readthedocs/projects/migrations/0045_auto_20191017_0241.py

readthedocs/projects/models.py

tapaswenipathak · 2019-10-17T16:01:06Z

1184582? ok now? feeling really tired doing the fixes.

stsewd

1184582? ok now? feeling really tired doing the fixes.

Sorry about that, but the changes were necessary.

Thanks, looks good now.

humitos

I think the change is good, but I'd like to get some feedback on the English sentences to make it clearer.

humitos · 2019-11-18T18:08:55Z

docs/versions.rst

@@ -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.


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.

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

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

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

humitos · 2019-11-18T18:12:40Z

readthedocs/projects/models.py

+            'Show a warning banner with a link to the stable version on not'
+            ' stable versions, except for latest.'


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.

stale · 2020-01-02T18:38:38Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

tapaswenipathak changed the title ~~Add a banner for latest hints~~ Add a banner line for latest hints Sep 6, 2019

tapaswenipathak force-pushed the ticket-6096 branch from 78b8ee4 to 2b1ccab Compare September 6, 2019 14:54

Add a banner line for latest hints

2b1ccab

stsewd reviewed Sep 9, 2019

View reviewed changes

docs/versions.rst Outdated Show resolved Hide resolved

tapaswenipathak and others added 2 commits September 10, 2019 03:41

Add proper warning message

3db5d3f

fix wording

9615df9

Co-Authored-By: Santos Gallegos <[email protected]>

stsewd reviewed Sep 9, 2019

View reviewed changes

readthedocs/projects/models.py Outdated Show resolved Hide resolved

humitos added the PR: work in progress Pull request is not ready for full review label Oct 9, 2019

merge commit

f088775

tapaswenipathak force-pushed the ticket-6096 branch 2 times, most recently from 5c37141 to 2d86838 Compare October 15, 2019 14:17

add banner for unstable documentation

0ea6e39

tapaswenipathak force-pushed the ticket-6096 branch from 2d86838 to 0ea6e39 Compare October 15, 2019 14:25

stsewd requested changes Oct 15, 2019

View reviewed changes

text fixes

4919254

tapaswenipathak added 2 commits October 17, 2019 05:18

banner text for unstable documentation

90a0890

travis fixes

4f7b86e

stsewd reviewed Oct 17, 2019

View reviewed changes

readthedocs/projects/migrations/0024_add-show-version-warning.py Outdated Show resolved Hide resolved

readthedocs/projects/migrations/0045_auto_20191017_0241.py Outdated Show resolved Hide resolved

readthedocs/projects/models.py Outdated Show resolved Hide resolved

address review

1184582

stsewd approved these changes Oct 17, 2019

View reviewed changes

stsewd removed the PR: work in progress Pull request is not ready for full review label Oct 17, 2019

stsewd requested a review from a team October 17, 2019 20:56

humitos requested changes Nov 18, 2019

View reviewed changes

stale bot added the Status: stale Issue will be considered inactive soon label Jan 2, 2020

stsewd mentioned this pull request Jan 7, 2020

Check use of latest for latest unreleased versions vs latest stable versions #6096

Closed

stale bot closed this Jan 9, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a banner line for latest hints #6143

Add a banner line for latest hints #6143

tapaswenipathak commented Sep 6, 2019

arron-tij commented Sep 7, 2019 •

edited

Loading

tapaswenipathak commented Sep 7, 2019 •

edited

Loading

stsewd left a comment

stsewd commented Sep 9, 2019

tapaswenipathak commented Sep 9, 2019

tapaswenipathak commented Oct 15, 2019

stsewd Oct 15, 2019

tapaswenipathak Oct 16, 2019

stsewd Oct 15, 2019

tapaswenipathak Oct 16, 2019

tapaswenipathak commented Oct 16, 2019

stsewd commented Oct 16, 2019

tapaswenipathak commented Oct 16, 2019

stsewd commented Oct 16, 2019

tapaswenipathak commented Oct 17, 2019

tapaswenipathak commented Oct 17, 2019 •

edited

Loading

stsewd left a comment

humitos left a comment

humitos Nov 18, 2019

humitos Nov 18, 2019

stsewd Nov 18, 2019

humitos Nov 18, 2019

humitos Nov 18, 2019

stale bot commented Jan 2, 2020

	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.

		'Show a warning banner with a link to the stable version on not'
		' stable versions, except for latest.'

Add a banner line for latest hints #6143

Add a banner line for latest hints #6143

Conversation

tapaswenipathak commented Sep 6, 2019

arron-tij commented Sep 7, 2019 • edited Loading

tapaswenipathak commented Sep 7, 2019 • edited Loading

stsewd left a comment

Choose a reason for hiding this comment

stsewd commented Sep 9, 2019

tapaswenipathak commented Sep 9, 2019

tapaswenipathak commented Oct 15, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tapaswenipathak commented Oct 16, 2019

stsewd commented Oct 16, 2019

tapaswenipathak commented Oct 16, 2019

stsewd commented Oct 16, 2019

tapaswenipathak commented Oct 17, 2019

tapaswenipathak commented Oct 17, 2019 • edited Loading

stsewd left a comment

Choose a reason for hiding this comment

humitos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stale bot commented Jan 2, 2020

arron-tij commented Sep 7, 2019 •

edited

Loading

tapaswenipathak commented Sep 7, 2019 •

edited

Loading

tapaswenipathak commented Oct 17, 2019 •

edited

Loading