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

Edit Orchestration Getting Started Guide #2601

Open
StackScribe opened this issue Nov 29, 2023 · 2 comments
Open

Edit Orchestration Getting Started Guide #2601

StackScribe opened this issue Nov 29, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@StackScribe
Copy link
Contributor

StackScribe commented Nov 29, 2023

Description

The Getting Started Guide for Observabillity needs to be edited:

  • Needs a better intro
  • Some flawed syntax, punctuation
  • Needs to conform to style guidelines we have defined
  • Needs better xrefs to other docs for more information
    • Getting started guides should provide a bridge into the main documentation
    • Propose that links throughout the content could be distracting for some new users so, for Getting started guides only, propose that we deviate from our standard practice and instead add a "To learn more" subsection to each major section and add appropriate xrefs there.

DoD

  • Intro makes sense for someone who comes to this page without much prior knowledge
  • Syntax is good
  • Conforms to style guidelines for capitalization of terms, links to k8s docs for major items
  • Contains appropriate links to the Guides and reference pages and possibly Kubernetes docs
@StackScribe StackScribe added documentation Improvements or additions to documentation status: ready-for-refinement Issue is relevant for the next backlog refinment labels Nov 29, 2023
@StackScribe StackScribe added this to the 0.10 milestone Nov 29, 2023
@aryasoni98
Copy link

I would like to work on it. Please assign me .

@mowies
Copy link
Member

mowies commented Dec 5, 2023

This ticket is not refined yet. We will refine it on wednesday in the community meeting. Then I'll gladly assign you :)

@mowies mowies removed the status: ready-for-refinement Issue is relevant for the next backlog refinment label Jan 24, 2024
@mowies mowies moved this to 🎟️ Refined in Keptn Lifecycle Toolkit Jan 24, 2024
@mowies mowies modified the milestones: 0.10, 0.11 Feb 12, 2024
@mowies mowies modified the milestones: 2.0.0-rc.1, 2.1.0 Mar 5, 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
Projects
Status: 🎟️ Refined
Development

No branches or pull requests

3 participants