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

Cover all important features with getting started guides #2237

Open
2 of 4 tasks
StackScribe opened this issue Oct 5, 2023 · 1 comment
Open
2 of 4 tasks

Cover all important features with getting started guides #2237

StackScribe opened this issue Oct 5, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation epic on hold Do not merge yet

Comments

@StackScribe
Copy link
Contributor

StackScribe commented Oct 5, 2023

Goal

The Keptn documentation set should have a "Getting started" section that includes individual exercises for each use-case plus additional "Getting started" exercises for key features.

Problem

We currently have two excellent "Getting started" exercises:

  • Getting started with Keptn observability
  • Getting started with lifecycle management (pre-/post-deployment tasks)

We also have three old exercises based on Andi's conference presentation and example. The example is not maintained by development and these exercises are not completely hands-on. These should be updated or removed:

  • Standardize observability
  • Manage release lifecycle
  • Custom Keptn metrics

We also have the original "Getting started" exercise put together in December 2022 to use the podtato-head example. It does not walk the user through all steps required for implementation, instead providing scripts that do some of the more complex configuration. It has been removed from the documentation set.

DoD

One "Getting started" section that includes:

  • Getting started with Keptn observability
  • Getting started with. lifecycle management (pre-/post-deployment tasks)
  • Getting started with Keptn metrics
  • Getting started with Keptn evaluations (may be incorporated into another exercise)
  • Getting started with Keptn analytics
  • Tutorials section removed from docs
  • All getting started exercises removed from Intro section
  • Each "Getting started" exercise linked from the "Intro" description of that feature" and from relevant "User guide" sections

Tasks

Preview Give feedback
  1. documentation good first issue status: in-progress
    StackScribe
  2. documentation on hold status: in-progress
    aryasoni98
  3. documentation on hold
  4. documentation
    StackScribe
@mowies
Copy link
Member

mowies commented Jan 23, 2024

I think we could revisit this epic but in a different way. We could have guides for all of the above suggestions but not as getting started guides and rather just in the guides section on the docs page. WDYT @StackScribe ?

@mowies mowies removed this from the 0.10 milestone Jan 23, 2024
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 on hold Do not merge yet
Projects
Status: No status
Development

No branches or pull requests

2 participants