Skip to content
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

Merged
merged 6 commits into from
Dec 4, 2023

Conversation

UtkarshUmre
Copy link
Member

This pull request adds links to the official Grafana documentation for creating and modifying dashboards in the README.md file.

Changes made:

  • Added links to the relevant sections of the Grafana documentation.
  • Ensured the links are accurate and functional.

Fixes #2538

@UtkarshUmre UtkarshUmre requested a review from a team as a code owner November 21, 2023 21:46
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 21, 2023
Copy link

netlify bot commented Nov 21, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit 3d92d92
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/6569d28bad08d80008a18fe3
😎 Deploy Preview https://deploy-preview-2539--keptn-lifecycle-toolkit.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@mowies mowies changed the title Added links to official Grafana documentation for creating and modifying dashboards docs: add links to official Grafana documentation for creating and modifying dashboards Nov 22, 2023
dashboards/grafana/README.md Outdated Show resolved Hide resolved
dashboards/grafana/README.md Outdated Show resolved Hide resolved
@StackScribe
Copy link
Contributor

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 make markdownlint-fix on your local branch and then pushing the new commit. Try that -- if it still doesn't pass, I'll look more carefully.

Copy link
Contributor

@StackScribe StackScribe left a 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...

@mowies
Copy link
Member

mowies commented Nov 22, 2023

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 :)
https://github.com/keptn/lifecycle-toolkit/tree/main/dashboards/grafana

Signed-off-by: UtkarshUmre <[email protected]>
Copy link
Member

@mowies mowies left a 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

dashboards/grafana/README.md Outdated Show resolved Hide resolved
dashboards/grafana/README.md Outdated Show resolved Hide resolved
odubajDT
odubajDT previously approved these changes Nov 22, 2023
Copy link
Member

@mowies mowies left a 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

@UtkarshUmre
Copy link
Member Author

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!

@mowies
Copy link
Member

mowies commented Nov 23, 2023

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.
Other than than, your contribution looks good to me!

@mowies mowies closed this Nov 23, 2023
@mowies mowies reopened this Nov 23, 2023
Copy link
Member

@mowies mowies left a 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 :)

@UtkarshUmre UtkarshUmre reopened this Dec 1, 2023
Copy link
Member Author

@UtkarshUmre UtkarshUmre left a 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

mowies
mowies previously approved these changes Dec 4, 2023
Signed-off-by: Moritz Wiesinger <[email protected]>
Copy link

sonarqubecloud bot commented Dec 4, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

Copy link

codecov bot commented Dec 4, 2023

Codecov Report

Merging #2539 (ae2832d) into main (3d92d92) will increase coverage by 0.08%.
Report is 6 commits behind head on main.
The diff coverage is n/a.

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

Flag Coverage Δ
certificate-operator 67.43% <ø> (ø)
component-tests 56.70% <ø> (+0.62%) ⬆️
lifecycle-operator 84.44% <ø> (ø)
metrics-operator 87.43% <ø> (ø)
scheduler 36.53% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@mowies mowies merged commit 6f2c18a into keptn:main Dec 4, 2023
38 checks passed
ahmedavid pushed a commit to ahmedavid/lifecycle-toolkit that referenced this pull request Dec 6, 2023
…difying dashboards (keptn#2539)

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: David Ahmadov <[email protected]>
@UtkarshUmre UtkarshUmre deleted the UtkarshUmre-patch-1 branch February 26, 2024 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Link Grafana docs on how to create or change custom dashboards
5 participants