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

Create "Getting Started" guides for three KLT use cases #1297

Closed
10 tasks done
StackScribe opened this issue Apr 27, 2023 · 2 comments
Closed
10 tasks done

Create "Getting Started" guides for three KLT use cases #1297

StackScribe opened this issue Apr 27, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation epic
Milestone

Comments

@StackScribe
Copy link
Contributor

StackScribe commented Apr 27, 2023

Goal

Create Getting Started Guides for three main use cases:

  • Keptn Metrics
  • Standardize access to Observability data
  • Orchestrate deployment checks

Problem

KLT generated much interest and enthusiasm at the Amsterdam KubeCon. We need documentation to enable new users to quickly get started when they come to our web site.

Technical Details

@grabnerandi has created a video outlining three use cases. We need to create Getting Started guides that walk new users through the steps required to implement each of these use cases and explain the value that KLT adds to the k8s features. These are based on Andi's sample application and we will use that sample for these guides.

Andi's video explains the different elements that need to be set up for the KLT use cases and we need to translate those into sequential steps (some of which may be iterative). We will define this list of steps on the intro page for the "Implementing KLT" section and then follow that order for the use-case guides. Out of these discussions, we may get the beginnings of some "Best practices" documentation to supplement the k8s "Best Practices."

DoD

Getting Started is a section, not a page. Initially, it contains the following sub-pages

  • Keptn Metrics
  • Observability
  • Orchestrate deployments
  • Generic "Getting Started" guide (the existing one with minor modifications)
  • It would be nice to have a link to the KLT Killercoda exercise here if it is ready.

Tasks

Preview Give feedback
  1. documentation
    StackScribe
  2. documentation
    StackScribe
  3. documentation stale
    StackScribe
  4. documentation stale
    StackScribe
  5. documentation stale
    aepfli
  6. documentation stale
    StackScribe
  7. documentation
    StackScribe
  8. documentation stale
    StackScribe
  9. documentation stale
  10. documentation stale
    StackScribe
@odubajDT
Copy link
Contributor

@StackScribe is something more needed to be documented? AFAIK this should be done

@StackScribe
Copy link
Contributor Author

This is done. Additional work is required for Getting started guides. That is defined in #2237

@github-project-automation github-project-automation bot moved this from 🎟️ Refined to ✅ Done in Keptn Lifecycle Toolkit Oct 5, 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 epic
Projects
Archived in project
Development

No branches or pull requests

3 participants