-
Notifications
You must be signed in to change notification settings - Fork 126
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add links to official Grafana documentation for creating and modifying dashboards #2539
Conversation
✅ Deploy Preview for keptn-lifecycle-toolkit ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
markdownlint does not like long source lines or lines that have more than one sentence. The good news is that you can easily fix most of these issues by running |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nicely done! Incorporate the comments and make peace with markdownlint and I'll approve.
One question -- do we have some sort of default Grafana dashboard for Keptn that someone who is playing with Keptn for the first time could grab to get something useful? It would be nice if someone who is exploring Keptn for the first time could quickly get a dashboard to use without much effort. Not for this PR in any event...
We have a whole folder with custom grafana dashboards :) |
Signed-off-by: UtkarshUmre <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
some suggestions to fix the linting issues
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The removed content in the readme is still valuable since we still have those custom dashboards available for users. I think we should keep the old content and add the new content at the end
hey @mowies I appreciate your input. To clarify, the primary goal of the issue was to direct users to the relevant Grafana documentation without introducing new documentation within the README. My changes aimed to achieve this by redirecting users to Grafana's official docs. If you prefer to retain the old content while adding the new information at the end, I'm happy to make those adjustments. I just wanted to ensure we maintain the focus on linking to the Grafana documentation as specified in the issue. Your clarification would be greatly appreciated. Thank you! |
It would be great if you could just add your new content below the old content. We still need the information about how to use our custom dashboards that are already available in the folder. |
Signed-off-by: UtkarshUmre <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! You just need to fix the markdown lint errors :)
c2c3827
to
3d92d92
Compare
…rors Signed-off-by: UtkarshUmre <[email protected]>
Signed-off-by: UtkarshUmre <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added new content to the end of the document and corrected linting errors
Signed-off-by: Moritz Wiesinger <[email protected]>
Kudos, SonarCloud Quality Gate passed! 0 Bugs No Coverage information |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #2539 +/- ##
==========================================
+ Coverage 85.44% 85.53% +0.08%
==========================================
Files 155 155
Lines 10175 10175
==========================================
+ Hits 8694 8703 +9
+ Misses 1201 1194 -7
+ Partials 280 278 -2 see 2 files with indirect coverage changes
Flags with carried forward coverage won't be shown. Click here to find out more. |
…difying dashboards (keptn#2539) Co-authored-by: Moritz Wiesinger <[email protected]> Signed-off-by: David Ahmadov <[email protected]>
This pull request adds links to the official Grafana documentation for creating and modifying dashboards in the README.md file.
Changes made:
Fixes #2538