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 first iteration of analysis documentation #2167

Merged
merged 53 commits into from
Sep 27, 2023

Conversation

RealAnna
Copy link
Contributor

@RealAnna RealAnna commented Sep 25, 2023

@RealAnna RealAnna requested review from a team as code owners September 25, 2023 11:40
@github-actions github-actions bot added documentation Improvements or additions to documentation metrics-operator labels Sep 25, 2023
@codecov
Copy link

codecov bot commented Sep 25, 2023

Codecov Report

Merging #2167 (d4ac76d) into main (98097e6) will increase coverage by 0.01%.
Report is 3 commits behind head on main.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2167      +/-   ##
==========================================
+ Coverage   84.52%   84.54%   +0.01%     
==========================================
  Files         152      153       +1     
  Lines        9804     9881      +77     
==========================================
+ Hits         8287     8354      +67     
- Misses       1230     1238       +8     
- Partials      287      289       +2     

see 5 files with indirect coverage changes

Flag Coverage Δ
certificate-operator 65.91% <ø> (ø)
component-tests 58.03% <ø> (-0.62%) ⬇️
keptn-lifecycle-operator ?
lifecycle-operator 85.02% <ø> (ø)
metrics-operator 87.61% <ø> (+0.20%) ⬆️
scheduler 32.12% <ø> (ø)

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

@RealAnna RealAnna marked this pull request as draft September 25, 2023 11:49
@odubajDT
Copy link
Contributor

Would it makes sense to link the SLO and SLI conversion docs to this? When we are referring to Keptn v1, some users might find it helpful how to convert their manifests

@RealAnna
Copy link
Contributor Author

Would it makes sense to link the SLO and SLI conversion docs to this? When we are referring to Keptn v1, some users might find it helpful how to convert their manifests

sure, where is it?

@odubajDT
Copy link
Contributor

Would it makes sense to link the SLO and SLI conversion docs to this? When we are referring to Keptn v1, some users might find it helpful how to convert their manifests

sure, where is it?

https://github.com/keptn/lifecycle-toolkit/tree/main/metrics-operator/converter

@netlify
Copy link

netlify bot commented Sep 25, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit d4ac76d
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/65141519541a9700080e1672
😎 Deploy Preview https://deploy-preview-2167--keptn-lifecycle-toolkit.netlify.app/docs/implementing/slo
📱 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.

@RealAnna RealAnna marked this pull request as ready for review September 25, 2023 13:59
@StackScribe
Copy link
Contributor

This is an excellent start to the docs and gives me enough information to take over, I think. I started nitting at your prose, the source code line lengths, etc but that is silly! You don't need to be bothered by such things! Let's get this so it passes markdownlint and get it merged. I can take it from here.

RealAnna and others added 12 commits September 27, 2023 13:29
Signed-off-by: realanna <[email protected]>
Co-authored-by: odubajDT <[email protected]>
Signed-off-by: RealAnna <[email protected]>
Signed-off-by: realanna <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: RealAnna <[email protected]>
Signed-off-by: realanna <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: RealAnna <[email protected]>
Signed-off-by: realanna <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: RealAnna <[email protected]>
Signed-off-by: realanna <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: RealAnna <[email protected]>
Signed-off-by: realanna <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: RealAnna <[email protected]>
Signed-off-by: realanna <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: RealAnna <[email protected]>
Signed-off-by: realanna <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: RealAnna <[email protected]>
Signed-off-by: realanna <[email protected]>
Signed-off-by: realanna <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: RealAnna <[email protected]>
Signed-off-by: realanna <[email protected]>
Signed-off-by: realanna <[email protected]>
@RealAnna RealAnna force-pushed the docs/1824/draft_analysis_docs branch from 905805f to 66080d6 Compare September 27, 2023 11:29
odubajDT
odubajDT previously approved these changes Sep 27, 2023
Signed-off-by: realanna <[email protected]>
RealAnna and others added 2 commits September 27, 2023 13:38
Signed-off-by: realanna <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: RealAnna <[email protected]>
@sonarcloud
Copy link

sonarcloud bot commented Sep 27, 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
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!

@RealAnna RealAnna merged commit 366ee1f into main Sep 27, 2023
29 checks passed
@RealAnna RealAnna deleted the docs/1824/draft_analysis_docs branch September 27, 2023 11:45
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 metrics-operator
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the Analysis feature
6 participants