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

Update integrate with apps page #2497

Closed
Tracked by #2222
mowies opened this issue Nov 14, 2023 · 3 comments · Fixed by #2639
Closed
Tracked by #2222

Update integrate with apps page #2497

mowies opened this issue Nov 14, 2023 · 3 comments · Fixed by #2639
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@mowies
Copy link
Member

mowies commented Nov 14, 2023

Goal

The "Integrate Keptn with your applications" page could use some updating.

Details

  • create a separate page and move the content about basic annotations and labels vs annotations there
  • double check that auto app discovery content is gone from the page
  • check if the content about pre and post deployment tasks is valuable. If so,move it into the "deployment tasks" page and link to that page
  • check if the initial page is still needed at all after moving out lots of content

Depends on #2490

@mowies mowies added the documentation Improvements or additions to documentation label Nov 14, 2023
@mowies mowies added this to the 0.10 milestone Nov 14, 2023
@mowies mowies added status: ready-for-refinement Issue is relevant for the next backlog refinment and removed status: ready-for-refinement Issue is relevant for the next backlog refinment labels Nov 14, 2023
@StackScribe
Copy link
Contributor

Do you mean to delet the info about annotations vs. labels or to move it somewhere else. I realize that this is generic k8s stuff but I still think it's useful and may indeed go with the basic annotations. I don't object to moving it, just not sure where it should go.

@StackScribe
Copy link
Contributor

Should the keptn.sh/container annotation be moved to the "Deployment tasks" along with the pre- and post-deployment tasks? I don't think it's relevant if one is not doing tasks that have containers. Also, the guide and reference pages that discuss containers should mention/link to the info about this annotation.

@mowies
Copy link
Member Author

mowies commented Nov 22, 2023

Do you mean to delet the info about annotations vs. labels or to move it somewhere else. I realize that this is generic k8s stuff but I still think it's useful and may indeed go with the basic annotations. I don't object to moving it, just not sure where it should go.

No I mostly want to move content around. The info about pre and post deployments could probably be removed since we have a full page on that already.

Should the keptn.sh/container annotation be moved to the "Deployment tasks" along with the pre- and post-deployment tasks? I don't think it's relevant if one is not doing tasks that have containers. Also, the guide and reference pages that discuss containers should mention/link to the info about this annotation.

No, that's only relevant for the auto app discovery I think so I would move the content there. But be careful, this has nothing to do with the container runtime so those sections also don't need to be adapted for this.

@StackScribe

@StackScribe StackScribe self-assigned this Nov 22, 2023
@mowies mowies moved this to 🎟️ Refined in Keptn Lifecycle Toolkit Nov 23, 2023
@mowies mowies moved this from 🎟️ Refined to 🏃 In progress in Keptn Lifecycle Toolkit Nov 23, 2023
@github-project-automation github-project-automation bot moved this from 🏃 In progress to ✅ Done in Keptn Lifecycle Toolkit Dec 20, 2023
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

Successfully merging a pull request may close this issue.

2 participants