keptn / lifecycle-toolkit

Toolkit for cloud-native application lifecycle management
https://keptn.sh
Apache License 2.0
272 stars 111 forks source link

Cover all important features with getting started guides #2237

Open StackScribe opened 9 months ago

StackScribe commented 9 months ago

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:

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:

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:

### Tasks
- [ ] https://github.com/keptn/lifecycle-toolkit/issues/2234
- [ ] https://github.com/keptn/lifecycle-toolkit/issues/2235
- [ ] https://github.com/keptn/lifecycle-toolkit/issues/2236
- [ ] https://github.com/keptn/lifecycle-toolkit/issues/2203
mowies commented 5 months ago

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 ?