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

Rewrite intro-klt for Sept 7 rollout #2005

Closed
StackScribe opened this issue Sep 3, 2023 · 2 comments
Closed

Rewrite intro-klt for Sept 7 rollout #2005

StackScribe opened this issue Sep 3, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@StackScribe
Copy link
Contributor

StackScribe commented Sep 3, 2023

The "Introduction to Keptn" must be rewritten before the September 7 publication of the docs that uses "Keptn" as the name of the project formerly known as "Keptn Lifecycle Toolkit" or KLT. Specific changes:

  • Modify weight so this appears before "Getting Started" in the doc contents
  • The left frame of intro-klt expands into subsections for usability cases but these are not ## sections in that document but rather links to some of the old "Getting started" exercises, and they are not in the same order that these use-cases (and future components) are discussed in this document. Let's figure out the order in which we want to discuss these and then make it work. And note that the exercises as written should be done in a different order -- the "Observability" exercise recommends that you do the "Custom metrics" exercise first and then go on to the "Manage release cycle" exercise. Remember that these exercises are tied tightly to Andi's presentation and should work with that video.
  • Make "Getting started with Keptn" look like other major section headers in left frame of docs
  • Make it read well! The current version has no "flow" and is a hot mess!
  • First sentence says this section contains tutorials and then puts the old Getting Started guides under this section? Is that what we want?
    • What then is the purpose of the "Tutorials" section?
    • I'd rather have this be a nice, readable introduction that then hands off to the good Getting Started exercise we have.
    • And what happened to the original "Getting started" that references the PodtatoHead example? Was that deliberately deleted or did it slip through the cracks? The paragraph that begins "To get started with Keptn" seems to link to what was the "Getting started" section
  • Do we want, "integrates with GitOps tools" or something more generic like "integrates with standard deployment tools"? It seems like using GitOps here needlessly discourages people who are not yet doing GitOps
    • Related to this, why is the topic sentence for the new "Getting started" exercise "Keptn works whether or not you use a GitOps strategy"???? And what is an "imperative walkthrough" -- you must do this or else????
  • Add CloudEvents to list of signals Keptn emits
  • Structure it for the three "use cases" and use the titles for those use cases that will eventually be the names of the separate modules. And justify these names with the table in the main README.md file that shows current state of each component.
    • This means moving info about pre- and post-deployment tasks into the section about the "Release Lifecycle" usability case.
    • The little paragraph about workloads and KeptnApp resources needs to be later in the document and be a little clearer
    • Need better discussion about evaluations and SLOs that lays the groundwork for when we complete the Analysis feature
  • Minimize info about Keptn V1 (although maintain a bit of historical info that is essential for understanding)
  • Figure out what to do about links to youtube videos. Perhaps a generic reference to the Keptn youtube site, although that needs to be cleaned up to make it usable.
@StackScribe StackScribe added the documentation Improvements or additions to documentation label Sep 3, 2023
@StackScribe StackScribe added this to the 0.9 milestone Sep 3, 2023
@StackScribe StackScribe self-assigned this Sep 3, 2023
@StackScribe StackScribe added the status: ready-for-refinement Issue is relevant for the next backlog refinment label Sep 3, 2023
@StackScribe StackScribe removed the status: ready-for-refinement Issue is relevant for the next backlog refinment label Sep 6, 2023
@agardnerIT
Copy link
Contributor

@StackScribe can this be closed?

@odubajDT
Copy link
Contributor

@StackScribe I think this issue can be closed, as it is finished. If not please feel free to reopen it :)

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
Archived in project
Development

No branches or pull requests

3 participants