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.

Sign up for GitHub

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

Jump to bottom

docs: improve "Intro to Keptn" page #2040

Merged
merged 4 commits into from
Sep 6, 2023
Merged

docs: improve "Intro to Keptn" page #2040

merged 4 commits into from
Sep 6, 2023

Conversation

StackScribe
Copy link
Contributor

Partially satisfies #2005

This PR improves the "Intro to KLT" page:

  • Intro page appears before "Getting started" page
  • Improve the flow by grouping descriptive information into the three use-cases, which should map to the future modules
  • Removed the first sentence that says the section includes tutorials although those old tutorials are still listed here.
  • Removed the "GitOps" term, which seemed to be making people who are not doing full GitOps feel that Keptn was not for them
  • Add CloudEvents to list of signals Keptn emits
  • Remove info about Keptn v1 and the history of Keptn as well as the links to the youtube videos
  • Add a sentence that is ready to link to Stacey's blog, which discusses the history of the Keptn project, what Keptn v1 is, and points readers to the youtube videos. A separate PR will insert the link to the blog just before we publish.

@StackScribe
docs: improve "Intro to Keptn" page
491382c 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe StackScribe added this to the 0.9 milestone Sep 6, 2023
@StackScribe StackScribe self-assigned this Sep 6, 2023
@StackScribe StackScribe requested review from a team as code owners September 6, 2023 04:23
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 6, 2023
@netlify
Copy link

netlify bot commented Sep 6, 2023 •
edited

✅ Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit ab0cc05
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/64f8568257093d00089a7671
😎 Deploy Preview https://deploy-preview-2040--keptn-lifecycle-toolkit.netlify.app/docs/intro
📱 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.

thisthat
thisthat previously approved these changes Sep 6, 2023
View reviewed changes
docs/content/en/docs/intro/_index.md Outdated Show resolved Hide resolved
@StackScribe @thisthat
Update docs/content/en/docs/intro/_index.md
c0e0b86 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com>
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
thisthat
thisthat previously approved these changes Sep 6, 2023
View reviewed changes
mowies
mowies reviewed Sep 6, 2023
View reviewed changes
docs/content/en/docs/intro/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/intro/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/intro/_index.md Show resolved Hide resolved
docs/content/en/docs/intro/_index.md Show resolved Hide resolved
@StackScribe
link to blog
1d021ba 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe
mo's comments
ab0cc05 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@sonarcloud
Copy link

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

@thisthat thisthat merged commit af4f417 into keptn:main Sep 6, 2023
16 checks passed
@keptn-bot keptn-bot mentioned this pull request Sep 6, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thisthat thisthat thisthat approved these changes

@mowies mowies mowies approved these changes

Assignees

@StackScribe StackScribe

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.8.3
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@StackScribe @thisthat @mowies