docs: improve Notes within the documentation #962
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
aepfli
requested review from
thisthat,
thschue,
bacherfl,
StackScribe and
RealAnna
as code owners
✅ Deploy Preview for keptn-lifecycle-toolkit ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
waiting for #963 to get merged, to solve the markdown issues |
|
Comparison of old versus new
|
StackScribe
previously approved these changes
Mar 3, 2023
There was a problem hiding this comment.
lgtm -- thanks. I need to find a place to document this since it is not actually a CSS/tools change but rather a coding convention. For now, I added it to the Word list for discussion. We'll figure out what to do with it when we start writing up issues that the community has approved.
With this little changes, `Notes` are way better visible and follow the standard definition which can also be used within GitHub markdown. Instead of **NOTE:** a note we do > **Note** a note Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
aepfli
force-pushed
the
chore/improve_notices_and_warnings
branch
from
f2befd3
to
4ace6af
Compare
Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
|
#1031 is a demo, of a markdown-lint rule to prevent this, and to fix this automatically :) |
Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
|
Kudos, SonarCloud Quality Gate passed!
|
StackScribe
approved these changes
Mar 16, 2023
Merged
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.
With this little changes,
Notesare way better visible andfollow the standard definition which can also be used within
GitHub markdown.
Instead of
NOTE: a note
we do