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 "Intro to KLT"; edit "Getting Started" #785

Merged
merged 17 commits into from
Mar 9, 2023
Merged

docs: add "Intro to KLT"; edit "Getting Started" #785

merged 17 commits into from
Mar 9, 2023

Conversation

StackScribe
Copy link
Contributor

Signed-off-by: Meg McRoberts [email protected]

This PR:

  • Creates the "Introduction to KLT" page, pulling the opening paragraphs out of the "Getting Started" Guide
  • Adds links to some current presentations that provide more introductory material about KLT
  • Edits "Getting Started" to remove the paragraphs that are now in the Intro and fix some small syntactical and style issues

@codecov
Copy link

codecov bot commented Feb 7, 2023

Codecov Report

Merging #785 (8c5d30a) into main (444ba74) will increase coverage by 0.11%.
The diff coverage is n/a.

❗ Current head 8c5d30a differs from pull request most recent head d24c4d0. Consider uploading reports for the commit d24c4d0 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #785      +/-   ##
==========================================
+ Coverage   57.38%   57.50%   +0.11%     
==========================================
  Files         119      119              
  Lines        9914     9913       -1     
==========================================
+ Hits         5689     5700      +11     
+ Misses       4027     4015      -12     
  Partials      198      198              
Impacted Files Coverage Δ
...ptnworkloadinstance/reconcile_prepostdeployment.go 81.81% <0.00%> (-9.10%) ⬇️
...ator/controllers/lifecycle/keptntask/controller.go 54.94% <0.00%> (-3.30%) ⬇️
metrics-operator/pkg/metrics/server.go 68.54% <0.00%> (-0.26%) ⬇️
operator/controllers/common/evaluationhandler.go 79.71% <0.00%> (+2.17%) ⬆️
...lers/lifecycle/keptnworkloadinstance/controller.go 82.95% <0.00%> (+4.03%) ⬆️
...ptnworkloadinstance/reconcile_prepostevaluation.go 90.90% <0.00%> (+18.18%) ⬆️
Flag Coverage Δ
certificate-operator ?
component-tests 50.99% <ø> (+1.54%) ⬆️
keptn-lifecycle-operator 53.63% <ø> (+<0.01%) ⬆️
klt-cert-manager 64.15% <ø> (?)
lifecycle-operator ?
metrics-operator 62.95% <ø> (-0.04%) ⬇️
scheduler 21.17% <ø> (ø)

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

@grabnerandi
Copy link
Member

looks good. One more thing. Henrik Rexed is currently working on an IsItObservable YouTube Tutorial for KLT. I think that would be a great asset as well on "How to get started". Here is the github repo that goes along with his youtube tutorial -> https://github.com/isItObservable/keptn-lifecycle-Toolkit. the tutorial itself should go live any day now

@StackScribe
Copy link
Contributor Author

Thanks, @grabnerandi ! I just added a link to the docs for this. I'll add a link to the video as soon as it is posted.

@thschue thschue changed the title Add "Intro to KLT"; edit "Getting Started" docs: add "Intro to KLT"; edit "Getting Started" Feb 7, 2023
docs/content/en/docs/intro-klt.md Outdated Show resolved Hide resolved
docs/content/en/docs/intro-klt.md Outdated Show resolved Hide resolved
docs/content/en/docs/intro-klt.md Outdated Show resolved Hide resolved
docs/content/en/docs/intro-klt.md Outdated Show resolved Hide resolved
docs/content/en/docs/intro-klt.md Outdated Show resolved Hide resolved
docs/content/en/docs/intro-klt.md Outdated Show resolved Hide resolved
docs/content/en/docs/intro-klt.md Outdated Show resolved Hide resolved
docs/content/en/docs/intro-klt.md Outdated Show resolved Hide resolved
docs/content/en/docs/intro-klt.md Outdated Show resolved Hide resolved
docs/content/en/docs/intro-klt.md Outdated Show resolved Hide resolved
Copy link
Contributor

@thschue thschue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made some suggestions

docs/content/en/docs/intro-klt.md Outdated Show resolved Hide resolved
docs/content/en/docs/intro-klt.md Outdated Show resolved Hide resolved
docs/content/en/docs/intro-klt.md Outdated Show resolved Hide resolved
docs/content/en/docs/intro-klt.md Outdated Show resolved Hide resolved
agardnerIT
agardnerIT previously approved these changes Feb 20, 2023
Copy link
Contributor

@agardnerIT agardnerIT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great!

@thschue thschue self-requested a review February 28, 2023 09:37
@aepfli aepfli added the documentation Improvements or additions to documentation label Mar 1, 2023
@netlify
Copy link

netlify bot commented Mar 3, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit d24c4d0
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/6409d8312b313d000823c487
😎 Deploy Preview https://deploy-preview-785--keptn-lifecycle-toolkit.netlify.app/docs/intro-klt
📱 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.

@sonarcloud
Copy link

sonarcloud bot commented Mar 3, 2023

SonarCloud Quality Gate failed.    Quality Gate failed

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
3.0% 3.0% Duplication

thschue
thschue previously approved these changes Mar 6, 2023
Copy link
Contributor

@thschue thschue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

docs/content/en/docs/getting-started.md Outdated Show resolved Hide resolved
docs/content/en/docs/intro-klt.md Outdated Show resolved Hide resolved
mowies
mowies previously approved these changes Mar 7, 2023
StackScribe and others added 8 commits March 7, 2023 10:05
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Simon Schrottner <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Simon Schrottner <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Simon Schrottner <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Simon Schrottner <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Simon Schrottner <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Simon Schrottner <[email protected]>
Signed-off-by: Simon Schrottner <[email protected]>
Signed-off-by: Moritz Wiesinger <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Simon Schrottner <[email protected]>
BREAKING-CHANGE: The handling of the CRD lifecycle and metrics has been split into two different operators

feat(operator): adapt KeptnEvaluationDefinition to reflect changes in KeptnMetric and KeptnMetricsProvider
feat: use helmify to release our helm chart
feat(metrics-operator): added conversion webhook for KeptnMetric CRDs
feat(cert-manager): support certificate injection for all matching resources based on label selector
feat: introduce lifecycle.keptn.sh/v1alpha3 API version
feat(metrics-operator): allow KeptnMetrics to be placed in any namespace
feat: adapt examples to use KeptnMetric and KeptnMetricsProvider
chore(operator): remove KeptnMetric and KeptnEvaluationProvider from klt operator
fix(metrics-operator): adapt metric types from v1alpha1
fix(operator): invalid import of metrics
feat(metrics-operator): implement metric functionality
ci(metrics-operator): adapt pipelines
feat(metrics-operator): introduce migration from KeptnEvaluationProvider to KeptnMetricsProvider
feat(metrics-operator): introduce KeptnMetricsProvider CRD
feat: added the metrics-operator

Signed-off-by: Simon Schrottner <[email protected]>
aepfli and others added 4 commits March 7, 2023 10:05
Signed-off-by: Simon Schrottner <[email protected]>
Signed-off-by: Simon Schrottner <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@sonarcloud
Copy link

sonarcloud bot commented Mar 7, 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
3.0% 3.0% Duplication

Signed-off-by: Meg McRoberts [email protected]

Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
docs/content/en/docs/getting-started.md Outdated Show resolved Hide resolved
docs/content/en/docs/intro-klt.md Outdated Show resolved Hide resolved
docs/content/en/docs/intro-klt.md Outdated Show resolved Hide resolved
StackScribe and others added 3 commits March 9, 2023 04:57
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@sonarcloud
Copy link

sonarcloud bot commented Mar 9, 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
No Duplication information No Duplication information

Copy link
Contributor

@thschue thschue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@thschue thschue merged commit 27932ff into keptn:main Mar 9, 2023
This was referenced Mar 9, 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants