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.

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
merged 14 commits into from
Jul 10, 2019

Conversation

alurban
Copy link

@alurban alurban commented Jul 8, 2019

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:

  • Because many modern browsers do not natively support the dialog element (see this reference), I'm importing a polyfill that is widely compatible.
  • As a trade-off between ability to customize and ease of use, the python-markdown library is used to render release notes. This allows users to write notes to a 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 and afterword elements.

Test output showing the full suite of Network summary pages is available here.

cc @duncanmmacleod, @areeda

@alurban alurban added this to the 1.0.0 milestone Jul 8, 2019
@alurban alurban self-assigned this Jul 8, 2019
@codecov
Copy link

codecov bot commented Jul 8, 2019

Codecov Report

Merging #286 into master will increase coverage by 0.11%.
The diff coverage is 60.71%.

Impacted file tree graph

@@            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
Flag Coverage Δ
#Linux 38.99% <60.71%> (+0.11%) ⬆️
#python35 38.99% <60.71%> (+0.11%) ⬆️
#python36 38.99% <60.71%> (+0.11%) ⬆️
#python37 38.99% <60.71%> (+0.11%) ⬆️
Impacted Files Coverage Δ
gwsumm/html/static.py 100% <ø> (ø) ⬆️
gwsumm/html/html5.py 100% <100%> (ø) ⬆️
gwsumm/tabs/builtin.py 36.45% <33.33%> (+0.69%) ⬆️
gwsumm/tabs/core.py 31.31% <35.71%> (+0.14%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 83597c8...d537b9b. Read the comment docs.

@alurban alurban merged commit 8f286d4 into gwpy:master Jul 10, 2019
@alurban alurban deleted the whats-new branch July 10, 2019 00:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant