docs: improve markdown quality #498
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
Adding markdownlint for local execution and GitHub action via makefile. Additionally we provide a autofix target to easily fix documentation. Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
|
as a sneak peak - why i need some of those changes - eg. closing details tags missing etc. |
Codecov Report
@@ Coverage Diff @@
## main #498 +/- ##
=======================================
Coverage 63.39% 63.39%
=======================================
Files 15 15
Lines 1923 1923
=======================================
Hits 1219 1219
Misses 639 639
Partials 65 65 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
beeme1mr
approved these changes
Mar 15, 2023
Merged
toddbaert
pushed a commit
that referenced
this pull request
Mar 20, 2023
🤖 I have created a release *beep* *boop* --- <details><summary>flagd: 0.4.5</summary> ## [0.4.5](flagd/v0.4.4...flagd/v0.4.5) (2023-03-20) ### 📚 Documentation * improve markdown quality ([#498](#498)) ([c77fa37](c77fa37)) ### ✨ New Features * grpc connection options to flagd configuration options ([#532](#532)) ([aa74951](aa74951)) * Introduce flagd kube proxy ([#495](#495)) ([440864c](440864c)) </details> <details><summary>kube-flagd-proxy: 0.1.2</summary> ## [0.1.2](kube-flagd-proxy/v0.1.1...kube-flagd-proxy/v0.1.2) (2023-03-20) ### ✨ New Features * Introduce flagd kube proxy ([#495](#495)) ([440864c](440864c)) </details> <details><summary>core: 0.4.5</summary> ## [0.4.5](core/v0.4.4...core/v0.4.5) (2023-03-20) ### 🐛 Bug Fixes * **deps:** update kubernetes packages to v0.26.3 ([#533](#533)) ([6ddd5b2](6ddd5b2)) * **deps:** update module github.com/open-feature/open-feature-operator to v0.2.31 ([#527](#527)) ([7928130](7928130)) * **deps:** update module google.golang.org/protobuf to v1.29.1 [security] ([#504](#504)) ([59db0bb](59db0bb)) * **deps:** update module google.golang.org/protobuf to v1.30.0 ([#499](#499)) ([f650338](f650338)) ### ✨ New Features * grpc connection options to flagd configuration options ([#532](#532)) ([aa74951](aa74951)) * Introduce flagd kube proxy ([#495](#495)) ([440864c](440864c)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
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.
This PR
Adding markdownlint for local execution and GitHub action
via makefile. Additionally, we provide an auto-fix target to fix the documentation quickly.
Related Issues
First iteration for #497
Notes
Besides the checked int markdownlint configuration, I also applied the rule max-one-sentence-per-line