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 KLT intro page #1495

Merged
merged 10 commits into from
Jun 15, 2023
Merged

docs: update KLT intro page #1495

merged 10 commits into from
Jun 15, 2023

Conversation

pragatisaikia
Copy link
Contributor

@pragatisaikia pragatisaikia commented May 30, 2023

Fixes : #1467 and #1540

  • Restructured the text to include a dedicated section highlighting the three main use cases/features: Metrics, Observability, and Release lifecycle, incorporating relevant information from the Getting Started Guide.
  • Replaced the previous YouTube links with the latest videos that cover the respective topics. Replaced the paragraph that referenced the December Community meeting with a new reference to a specific video: link to the video.

Files changed : link to the file

Signed-off-by: Pragati Saikia <92122197+pragatisaikia@users.noreply.github.com>
@pragatisaikia pragatisaikia requested review from a team as code owners May 30, 2023 17:53
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 30, 2023
@netlify
Copy link

netlify bot commented May 30, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit 294a582
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/6486c9769001b2000887154a
😎 Deploy Preview https://deploy-preview-1495--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 settings.

@rakshitgondwal
Copy link
Member

Just wondering why markdownlint is not throwing an error over here, seems like it is requiring some kind of approval.
Also thank you for the PR @pragatisaikia! Can you modify the pr name to docs: update into-klt.md, that would fix the Semantic PR Validation error.

@rakshitgondwal
Copy link
Member

rakshitgondwal commented May 30, 2023

Also I'm not really sure that why do we need to shift to this from this for the comparison between Keptn V1 and the Keptn Lifecycle Toolkit. @StackScribe

Copy link
Member

@rakshitgondwal rakshitgondwal left a comment

Choose a reason for hiding this comment

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

These changes would fix the markdownlint errors.

FYI @StackScribe @thisthat

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
@StackScribe StackScribe changed the title Update intro-klt.md docs: update intro-klt.md May 30, 2023
@StackScribe
Copy link
Contributor

In re: @rakshitgondwal 's question about what videos to use to explain the difference between Keptn v1 and KLT... I'm not completely sure what to do about video references in the docs. They are a great way to add more information and many people do enjoy the videos and voice more than reading the text but we are also going to have to pay attention and keep updating the videos we use because they get outdated -- I'm sure we'll figure it out in time. I think the presentation Andi made in Pakistan is the most coherent presentation we have about the evolution from Keptn v1 to KLT and was thinking that maybe the meeting minutes were a little "rough". But we could certainly add Andi's Pakistan video and leave the meeting minutes video. Are you saying that you like the presentation from the community meeting better than the Pakistan video? Everyone has a vote here -- feel free to comment the issue saying that you think removing the link to the meeting minutes is stupid and say why!

@rakshitgondwal
Copy link
Member

In re: @rakshitgondwal 's question about what videos to use to explain the difference between Keptn v1 and KLT... I'm not completely sure what to do about video references in the docs. They are a great way to add more information and many people do enjoy the videos and voice more than reading the text but we are also going to have to pay attention and keep updating the videos we use because they get outdated -- I'm sure we'll figure it out in time. I think the presentation Andi made in Pakistan is the most coherent presentation we have about the evolution from Keptn v1 to KLT and was thinking that maybe the meeting minutes were a little "rough". But we could certainly add Andi's Pakistan video and leave the meeting minutes video. Are you saying that you like the presentation from the community meeting better than the Pakistan video? Everyone has a vote here -- feel free to comment the issue saying that you think removing the link to the meeting minutes is stupid and say why!

Yes! Actually, even me myself got to know about the difference between Keptn V1 and KLT from the meeting minutes video that's why I was more biased towards it. Just had one more question that the link for the KCD Pakistan video links to a specific timestamp of 2:50, so is this intentional or should we change the link?

pragatisaikia and others added 6 commits May 31, 2023 21:12
Co-authored-by: Rakshit Gondwal <98955085+rakshitgondwal@users.noreply.github.com>
Signed-off-by: Pragati Saikia <92122197+pragatisaikia@users.noreply.github.com>
Co-authored-by: Rakshit Gondwal <98955085+rakshitgondwal@users.noreply.github.com>
Signed-off-by: Pragati Saikia <92122197+pragatisaikia@users.noreply.github.com>
Co-authored-by: Rakshit Gondwal <98955085+rakshitgondwal@users.noreply.github.com>
Signed-off-by: Pragati Saikia <92122197+pragatisaikia@users.noreply.github.com>
Co-authored-by: Rakshit Gondwal <98955085+rakshitgondwal@users.noreply.github.com>
Signed-off-by: Pragati Saikia <92122197+pragatisaikia@users.noreply.github.com>
Signed-off-by: pragatisaikia <pragatisaikia2003@gmail.com>
@rakshitgondwal
Copy link
Member

I was just looking at this video which is a talk by Giovanni and Brad in KubeCon EU 2023, and I think we can consider this for the difference between V1 and KLT too. wdyt @StackScribe

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.

LGTM

@mowies mowies changed the title docs: update intro-klt.md docs: update KLT intro page Jun 7, 2023
@sonarcloud
Copy link

sonarcloud bot commented Jun 12, 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

@StackScribe StackScribe merged commit d1db5d2 into keptn:main Jun 15, 2023
@keptn-bot keptn-bot mentioned this pull request Jun 15, 2023
StackScribe added a commit to StackScribe/lifecycle-toolkit that referenced this pull request Jun 19, 2023
Signed-off-by: Pragati Saikia <92122197+pragatisaikia@users.noreply.github.com>
Signed-off-by: pragatisaikia <pragatisaikia2003@gmail.com>
Co-authored-by: Rakshit Gondwal <98955085+rakshitgondwal@users.noreply.github.com>
Co-authored-by: Meg McRoberts <DreidelLhasa@yahoo.com>
StackScribe added a commit to StackScribe/lifecycle-toolkit that referenced this pull request Jun 22, 2023
Signed-off-by: Pragati Saikia <92122197+pragatisaikia@users.noreply.github.com>
Signed-off-by: pragatisaikia <pragatisaikia2003@gmail.com>
Co-authored-by: Rakshit Gondwal <98955085+rakshitgondwal@users.noreply.github.com>
Co-authored-by: Meg McRoberts <DreidelLhasa@yahoo.com>
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.

Update "Intro to KLT"
4 participants