chore: improve markdownlint #946
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
Markdownlint is a crucial tool for us, but the usability was not as good as it could be. 1. It was confusing, as it was not accessible within the docs 2. The configuration deviated from the defaults, IDE-plugins did not pick up those settings 3. documentation of the setting was missing With this pull-request we address the points above, and make it easier to be used for our contributors. Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
aepfli
added
documentation
aepfli
requested review from
thisthat,
thschue,
bacherfl and
StackScribe
as code owners
StackScribe
reviewed
Mar 1, 2023
StackScribe
reviewed
Mar 1, 2023
Co-authored-by: Meg McRoberts <mmcroberts@cloudbees.com> Signed-off-by: Simon Schrottner <simon.schrottner@gmail.com>
Co-authored-by: Meg McRoberts <mmcroberts@cloudbees.com> Signed-off-by: Simon Schrottner <simon.schrottner@gmail.com>
StackScribe
reviewed
Mar 1, 2023
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #946 +/- ##
==========================================
+ Coverage 57.45% 57.50% +0.04%
==========================================
Files 119 119
Lines 9913 9914 +1
==========================================
+ Hits 5696 5701 +5
+ Misses 4018 4015 -3
+ Partials 199 198 -1
Flags with carried forward coverage won't be shown. Click here to find out more. |
StackScribe
reviewed
Mar 1, 2023
StackScribe
reviewed
Mar 1, 2023
StackScribe
previously approved these changes
Mar 1, 2023
There was a problem hiding this comment.
Good stuff -- thanks for writing this up! I added some suggestions for your consideration.
Long term, we should move this content to the Contributing guide but let's commit this as is for now.
Also need to link to the info about markdown-lint from the documentation Contributing.md file (see #758 ).
Co-authored-by: Meg McRoberts <mmcroberts@cloudbees.com> Signed-off-by: Simon Schrottner <simon.schrottner@gmail.com>
Co-authored-by: Meg McRoberts <mmcroberts@cloudbees.com> Signed-off-by: Simon Schrottner <simon.schrottner@gmail.com>
Co-authored-by: Meg McRoberts <mmcroberts@cloudbees.com> Signed-off-by: Simon Schrottner <simon.schrottner@gmail.com>
|
Please do not merge before #866 to reduce merge conflicts :) |
thisthat
previously approved these changes
Mar 1, 2023
mowies
reviewed
Mar 2, 2023
|
@mowies This file has more details than what is in the CONTRIBUTING.md file and covers software facilities as well as the docs build engine. I am thinking that eventually (not real long term) we should make this doc part of the Contributing Guide and then have the CONTRIBUTING.md files point to that guide for info |
Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com> Signed-off-by: Simon Schrottner <simon.schrottner@gmail.com>
Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
✅ Deploy Preview for keptn-lifecycle-toolkit ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
mowies
previously approved these changes
Mar 2, 2023
Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
aepfli
force-pushed
the
chore/markdownlint-improvements
branch
from
7234ce7
to
b0dedde
Compare
Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
mowies
requested changes
Mar 6, 2023
Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
|
Kudos, SonarCloud Quality Gate passed!
|
mowies
approved these changes
Mar 6, 2023
Merged
thschue
pushed a commit
to thschue/lifecycle-controller
that referenced
this pull request
Mar 7, 2023
Co-authored-by: Meg McRoberts <mmcroberts@cloudbees.com> Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com>
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.
Markdownlint is a crucial tool for us, but the usability was not as good as it could be.
With this pull-request we address the points above, and make it easier to be used for our contributors.