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: update docs for multi metrics provider support, fix API reference generator #1251

Merged
merged 10 commits into from
Apr 20, 2023

Conversation

mowies
Copy link
Member

@mowies mowies commented Apr 19, 2023

This PR

  • adjusts the API reference generator script to work with the metrics API under the metrics operator
  • re-generates all metrics API references pages
  • adjusts all KeptnMetricProvider occurrences to the new API version while also introducing the new type field
  • adds some info about support for multiple providers of the same type

Part of #1144

@github-actions github-actions bot added documentation Improvements or additions to documentation ops labels Apr 19, 2023
@netlify
Copy link

netlify bot commented Apr 19, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit 6645050
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/6440f183e16bf9000861612e
😎 Deploy Preview https://deploy-preview-1251--keptn-lifecycle-toolkit.netlify.app/docs/concepts/metrics
📱 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 settings.

@codecov
Copy link

codecov bot commented Apr 19, 2023

Codecov Report

Merging #1251 (6645050) into main (3c465d0) will decrease coverage by 0.03%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1251      +/-   ##
==========================================
- Coverage   59.30%   59.27%   -0.03%     
==========================================
  Files         133      133              
  Lines       10105    10105              
==========================================
- Hits         5993     5990       -3     
- Misses       3895     3897       +2     
- Partials      217      218       +1     

see 3 files with indirect coverage changes

Flag Coverage Δ
certificate-operator 64.15% <ø> (ø)
component-tests 59.71% <ø> (-0.22%) ⬇️
lifecycle-operator 78.26% <ø> (ø)
metrics-operator 79.03% <ø> (ø)
scheduler 21.75% <ø> (ø)

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

@mowies mowies marked this pull request as ready for review April 19, 2023 11:26
@mowies
Copy link
Member Author

mowies commented Apr 19, 2023

FYI: @StackScribe the changes here will also be important for the upcoming YAML reference page for the KeptnMetricsProvider

Co-authored-by: Florian Bacher <[email protected]>
Signed-off-by: Moritz Wiesinger <[email protected]>
bacherfl
bacherfl previously approved these changes Apr 19, 2023
@mowies mowies changed the title docs: update docs for multi metrics provider support docs: update docs for multi metrics provider support, fix API reference generator Apr 20, 2023
odubajDT
odubajDT previously approved these changes Apr 20, 2023
Co-authored-by: Meg McRoberts <[email protected]>
Signed-off-by: Moritz Wiesinger <[email protected]>
@mowies mowies dismissed stale reviews from odubajDT and bacherfl via 0985b77 April 20, 2023 08:00
Co-authored-by: Meg McRoberts <[email protected]>
Signed-off-by: Moritz Wiesinger <[email protected]>
Co-authored-by: Meg McRoberts <[email protected]>
Signed-off-by: Moritz Wiesinger <[email protected]>
@sonarcloud
Copy link

sonarcloud bot commented Apr 20, 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
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.

Note that I am about to submit a PR that deletes the concepts/metrics/_index.md file and moves that information to different files in the new structure. My PR will include the updates made in this PR.

@mowies mowies merged commit 1dfd653 into keptn:main Apr 20, 2023
@mowies mowies deleted the multi-prov-docs-2 branch April 20, 2023 11:41
@keptn-bot keptn-bot mentioned this pull request Apr 20, 2023
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 ops
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants