Adds links to online guides in reports help #15030
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
sgiehl
force-pushed
the
reportonlineguides
branch
from
5a538c8
to
dc3f498
Compare
sgiehl
added
Needs Review
|
Looks good but haven't looked at tests yet. Be good to not merge this in 3.12 but 3.13 or so (which you already added as milestone) |
mattab
added
Enhancement
diosmosis
reviewed
Nov 6, 2019
for reports where the new onlineGuideUrl property is defined
sgiehl
force-pushed
the
reportonlineguides
branch
from
dc3f498
to
c7ca571
Compare
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.
In order to show links to the online guide in all reports where one is available, I've implemented a new report property
onlineGuideUrl. If it's defined for a report, a link will be shown in the report help.In addition that url will also be available in the metadata and thus when fetch all reports meta data through API.
Would currently look like this if a documentation and a archive date is set for the report:
refs #4481