-
Notifications
You must be signed in to change notification settings - Fork 2
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.
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
Announcements: allow user to close feature announcements #377
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
31 changes: 17 additions & 14 deletions
31
readthedocsext/theme/templates/projects/partials/dashboard/traffic-analytics.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,24 @@ | ||
{% load i18n %} | ||
|
||
{% with "https://docs.readthedocs.io/page/analytics.html" as url %} | ||
<div class="ui card"> | ||
<div class="content"> | ||
<a class="header" target="_blank" href="{{ url }}">{% trans "Prioritize your most-read pages" %}</a> | ||
<div class="description"> | ||
{% blocktrans %} | ||
Use <strong>traffic analytics</strong> to know <em>which</em> documents your users are reading. | ||
This allows you to understand how your documentation is being used and learn more about your audience. | ||
Then you can prioritize your efforts on expanding and updating pages people are reading most. | ||
{% endblocktrans %} | ||
<div data-bind="using: new ProjectAnnouncementView('traffic-analytics')"> | ||
<div class="ui card" data-bind="visible: !closed()"> | ||
<div class="content"> | ||
<i class="fa-solid fa-xmark right floated close icon" data-bind="click: close_announcement"></i> | ||
<a class="header" target="_blank" href="{{ url }}">{% trans "Prioritize your most-read pages" %}</a> | ||
<div class="description"> | ||
{% blocktrans %} | ||
Use <strong>traffic analytics</strong> to know <em>which</em> documents your users are reading. | ||
This allows you to understand how your documentation is being used and learn more about your audience. | ||
Then you can prioritize your efforts on expanding and updating pages people are reading most. | ||
{% endblocktrans %} | ||
</div> | ||
</div> | ||
<div class="ui extra content"> | ||
<a class="ui small primary fluid basic button" target="_blank" href="{{ url }}"> | ||
{% trans "Enable analytics" %} | ||
</a> | ||
</div> | ||
</div> | ||
<div class="ui extra content"> | ||
<a class="ui small primary fluid basic button" target="_blank" href="{{ url }}"> | ||
{% trans "Enable analytics" %} | ||
</a> | ||
</div> | ||
</div> | ||
{% endwith %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think what you have here might be prone to flashing content to the user -- the content will start visible and hide once the JS loads (and technically display again if the user hasn't dismissed?). I might be wrong here though, you can test by slowing down your network connection in Firefox.
There is a helper class that you can use for these sorts of cases. It just applies
display: none
, but avoids flashing the content to the user on load, before the JS hides the element. It uses some inverted logic of sort though, which would look like: remove thehidden
class if the notification should be visible.There are some examples of this in the templates, but I think it is something like this:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. Actually, I have this exact issue and I commented on Slack about this. It works better with your suggestion 👍🏼