-
Notifications
You must be signed in to change notification settings - Fork 23
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
Display release notes and help content in a dialog box #286
Merged
Conversation
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
…ely supported on a small subset of modern browsers
Codecov Report
@@ Coverage Diff @@
## master #286 +/- ##
==========================================
+ Coverage 38.88% 38.99% +0.11%
==========================================
Files 47 47
Lines 7387 7409 +22
==========================================
+ Hits 2872 2889 +17
- Misses 4515 4520 +5
Continue to review full report at Codecov.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR allows us to publish user-side release notes and help content for the summary pages. The notes themselves will be taken from configuration files, then wrapped in HTML and displayed in a
dialog
element. The user-facing way to activate this feature is a floating, sticky button showing a question mark.Two dependencies are introduced:
dialog
element (see this reference), I'm importing a polyfill that is widely compatible.README.md
-style document, then configure GWSumm to point to it. Note, this library is available through Conda.python-markdown will also now be used to render
foreword
andafterword
elements.Test output showing the full suite of Network summary pages is available here.
cc @duncanmmacleod, @areeda