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

Notification: allow to disable latest and/or non-stable warning #133

Closed
humitos opened this issue Sep 18, 2023 · 7 comments · Fixed by #414
Closed

Notification: allow to disable latest and/or non-stable warning #133

humitos opened this issue Sep 18, 2023 · 7 comments · Fixed by #414
Assignees
@humitos
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code

Comments

@humitos
Copy link
Member

humitos commented Sep 18, 2023 •
edited
Loading

The current pretty simple logic we have is good and it may work for most of the cases. However, it's a little verbose since it will show a notification in all the versions that are not stable --which could be a lot.

There are users that won't like this pattern and may not want to follow "our proposal to use the platform" here (most users should always read the stable version of the project's documentation) or may require an un-supported way to decide "stable" version.

These users should be able to decide whether or not show a warning notification on latest and/or on non-stable versions independently:

  • Enable the addons (disable it completely)
  • Show a notification on non-stable versions
  • Show a notification on latest version

Related
@humitos humitos added Improvement Minor improvement to code Accepted Accepted issue on our roadmap labels Sep 18, 2023
@humitos humitos self-assigned this Sep 18, 2023
@github-project-automation github-project-automation bot moved this to Planned in 📍Roadmap Sep 18, 2023
@Zylann
Copy link

Zylann commented May 2, 2024 •
edited
Loading

Is it about this warning?
image

I started noticing it only a few weeks ago, and I don't know how to get rid of it. Many users of my project use its latest version and it's annoying. Also even if it were desired, it covers the top of every page, requiring action to dismiss it each time.

Also I notice this is an "addon", but I don't remember setting this up anywhere? (new to this repo, maybe it's not what it means)

@humitos
Copy link
Member Author

humitos commented May 6, 2024

Hi @Zylann. This is new to Read the Docs as well. We have been migrating a lot of features we used to perform in the backend build process to a front-end application.

You can read more about this in our blog:

Note that you can disable this notification from your project's setting using the beta dashboard (more info about this in the second blog post). Let me know if that helps.

@agilgur5
Copy link

agilgur5 commented Jun 23, 2024 •
edited
Loading

Also even if it were desired, it covers the top of every page, requiring action to dismiss it each time.

Yes, this is pretty annoying, especially for contributors who use latest regularly (see also this thread in CNCF Slack for Argo Workflows contributors).

If it were less obtrusive or had a cookie or checkbox to remember that I hid it, that would be much nicer. For instance:

  • default to hide it for a week
  • allow users to optionally hide it -- some are well aware they are on a different version than stable
  • make it smaller at the top of the page, like a banner. as an example, here is mkdocs-material's version warning that is just above the header and so can just be scrolled past very easily. (all core Argo projects use mkdocs-material, for reference)

Otherwise, given how obtrusive it currently is, we will probably disable it entirely. I found this issue searching for how to disable it.

@humitos
Copy link
Member Author

humitos commented Jun 23, 2024

Thanks for your feedback @agilgur5 👍

If it were less obtrusive or had a cookie or checkbox to remember that I hid it, that would be much nicer

This is already implemented and will be deployed next week.

@humitos
Copy link
Member Author

humitos commented Jun 25, 2024

I just deployed a new version of the addons that includes the ability to dismiss a notification and not show it again on the same project/language/version. Feel free to open a new issue with any feedback you may have. Thanks 🙏🏼 cc @agilgur5

@agilgur5
Copy link

includes the ability to dismiss a notification and not show it again on the same project/language/version

Looks like it happens automatically? I didn't see an option, but I do see it remembers the dismissal and stores a timestamp in localStorage.

Looks like per #283 it's just permanent for now?
And I see this issue is roughly a duplicate of #46

@humitos
Copy link
Member Author

humitos commented Jun 27, 2024

@agilgur5 yes, it's permanent for now. We released this simplified version as a first step, but we plan to improve it with the feedback we receive.

@agilgur5 agilgur5 mentioned this issue Oct 24, 2024
Open
1 task
@humitos humitos mentioned this issue Oct 28, 2024
Closed
humitos added a commit to readthedocs/readthedocs.org that referenced this issue Oct 29, 2024
@humitos
Addons: allow users to show/hide notifications on latest/non-stable
5d5f64d 
We currently allow users to disable the latest and non-stable notifications with
only one checkbox. This PR split this checkbox into two, so users can decide to
show a notification on latest and/or on non-stable versions individually.

Note this PR also changes the addons API response: `non_latest_version_warning`
and `external_version_warning` are combined into `notifications`. I think nobody
is using this yet, so I'm not expecting issues with it. Let me know if you think
differently here.

Required by readthedocs/addons#133
@humitos humitos mentioned this issue Oct 29, 2024
Merged
humitos added a commit that referenced this issue Oct 29, 2024
@humitos
Notifications: allow disable latest and/or non-stable
1327731 
Closes #133
Requires readthedocs/readthedocs.org#11718
@humitos humitos mentioned this issue Oct 29, 2024
Merged
humitos added a commit to readthedocs/readthedocs.org that referenced this issue Nov 4, 2024
@humitos @ericholscher
Addons: allow users to show/hide notifications on latest/non-stable (#…
7120315 
…11718)

We currently allow users to disable the latest and non-stable
notifications with only one checkbox. This PR split this checkbox into
two, so users can decide to show a notification on latest and/or on
non-stable versions individually.

Note this PR also changes the addons API response:
`non_latest_version_warning` and `external_version_warning` are combined
into `notifications`. I think nobody is using this yet, so I'm not
expecting issues with it. Let me know if you think differently here.

Required by readthedocs/addons#133

---------

Co-authored-by: Eric Holscher <eric@ericholscher.com>
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
@humitos humitos closed this as completed in 81c058c Nov 4, 2024
@github-project-automation github-project-automation bot moved this from Needs review to Done in 📍Roadmap Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@humitos humitos

Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code
Projects
📍Roadmap
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Notifications: allow disable latest and/or non-stable readthedocs/addons
3 participants
@humitos @Zylann @agilgur5