Use markdown in the installed app notes #4143
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
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
Merged
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com> Conflicts: dashboard/src/components/AppView/AppNotes/AppNotes.test.tsx dashboard/src/components/AppView/AppNotes/AppNotes.tsx dashboard/src/components/OperatorView/OperatorDescription.tsx
absoludity
approved these changes
Jan 25, 2022
Co-authored-by: Michael Nelson <absoludity@gmail.com>
This was referenced May 23, 2022
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.
Description of the change
This PR adds support for rendering markdown in the installed app notes. Also changes the headers from h5 to h3; otherwise, those outputs including header markers
#will result in misleading hierarchies.Benefits
App notes will be able to render markdown text.
Possible drawbacks
Non-markdown files might have some weird spacing as a result of an improper md parsing output. However, I've tried to keep a format as similar as possible.
Applicable issues
Additional information
Before:
After: