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 metrics-operator architecture #1151

Merged
merged 10 commits into from
Apr 17, 2023
Merged

Conversation

rakshitgondwal
Copy link
Member

Fixes #1049

I have made the following changes in this PR:

  • Added the documentation for metrics operator architecture.
  • Separated metrics-operator, lifecycle-operator, KLT scheduler in three different folders by modifying architecture/components/_index.md

Signed-off-by: Rakshit Gondwal <[email protected]>
@netlify
Copy link

netlify bot commented Mar 29, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit 1ac6058
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/643d2047eb79460007af31d1
😎 Deploy Preview https://deploy-preview-1151--keptn-lifecycle-toolkit.netlify.app/docs/concepts/architecture/components/metrics-operator
📱 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.

Signed-off-by: Rakshit Gondwal <[email protected]>
@StackScribe
Copy link
Contributor

Line 11... github won't let me comment directly on that line, but I wonder if this is two components or three. Maybe say, "...the following components" and avoid the issue?

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.

Very nicely done! We need @thisthat and @bacherfl to review the content, including my comments, which need to be refined/corrected

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 12, 2023
Signed-off-by: Rakshit Gondwal <[email protected]>
@bacherfl
Copy link
Member

Thanks @rakshitgondwal for incorporating the changes for the description of the metrics! I found two minor nitpicks, but content wise the PR looks good

Signed-off-by: Rakshit Gondwal <[email protected]>
@rakshitgondwal
Copy link
Member Author

Due to the use of ../../../../yaml-crd-ref/metric the markdown-link-check is failing. Should we shift to https://main.lifecycle.keptn.sh/docs/yaml-crd-ref/metric/ or https://github.com/keptn/lifecycle-toolkit/blob/main/docs/content/en/docs/yaml-crd-ref/metric.md instead?

cc: @StackScribe @thisthat

@sonarcloud
Copy link

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

@bacherfl bacherfl merged commit 80d0045 into keptn:main Apr 17, 2023
@keptn-bot keptn-bot mentioned this pull request Apr 17, 2023
@rakshitgondwal
Copy link
Member Author

Thank you for the merge!

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.

Document architecture of Metrics Operator
5 participants