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

rename "Implementing" section to "User guides" #2087

Closed
StackScribe opened this issue Sep 13, 2023 · 4 comments · Fixed by #2097
Closed

rename "Implementing" section to "User guides" #2087

StackScribe opened this issue Sep 13, 2023 · 4 comments · Fixed by #2097
Assignees
Labels
documentation Improvements or additions to documentation research status: needs-discussion
Milestone

Comments

@StackScribe
Copy link
Contributor

"Implementing Keptn applications" (https://main.lifecycle.keptn.sh/docs/implementing/ ) is a lousy title. I propose we rename this section to just "User guides", which is boring but I think will make the information more accessible.

For discussion, how do we arrange the contents?

  • Option 1: Leave the contents pretty much as they are, but perhaps move a couple sections around to be in a more logical order
    • Less work to implement
    • Leaves all the titles viewable when you open "User Guides" in the left margin
  • Option 2: Create subsections for Metrics, Observability, and Release Lifecycle Maintenance and arrange the existing pages within those subsections. "Integrate" would stay at the top level -- not part of the other sections -- and we might end up with a few more "generic pages"
    • Keeps the left frame list shorter
    • Supports the increased modularity that is coming for Keptn
    • Also requires the user to know, for example, that "Dora metrics" are part of "Observability" rather than "Metrics"
@StackScribe StackScribe added documentation Improvements or additions to documentation research labels Sep 13, 2023
@StackScribe StackScribe added this to the 0.9 milestone Sep 13, 2023
@StackScribe StackScribe self-assigned this Sep 13, 2023
@agardnerIT
Copy link
Contributor

I think start with option 1

@mowies
Copy link
Member

mowies commented Oct 4, 2023

i also vote for option 1

@RealAnna
Copy link
Contributor

RealAnna commented Oct 4, 2023

yes 1 is perfect

@StackScribe
Copy link
Contributor Author

This is done. The "Implementing Keptn Applications" section is now called "User Guides" but has essentially the same structure as before.

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 research status: needs-discussion
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants