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

KeptnTask CRD ref page has no Examples #3178

Closed
StackScribe opened this issue Mar 5, 2024 · 2 comments
Closed

KeptnTask CRD ref page has no Examples #3178

StackScribe opened this issue Mar 5, 2024 · 2 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@StackScribe
Copy link
Contributor

StackScribe commented Mar 5, 2024

All examples and the "Examples" subsection itself have been removed from the KeptnTask reference page. The usage section has a reference to where to find one kind of example but that's all.

Users only need to create a KeptnTask resource when using Keptn with a non-Kubnernetes deployment. For K8s deployments, Keptn generates this resource automatically.

Still, the reference page should have an "Example" section. The last sentence of the "Usage" section points to the guide chapter so we just need to add the header.

DoD

  • Add "Example" subsection and include existing sentence that references the guide.
@StackScribe StackScribe added bug Something isn't working documentation Improvements or additions to documentation labels Mar 5, 2024
@StackScribe StackScribe added this to the 2.0.0-rc.1 milestone Mar 5, 2024
@mowies
Copy link
Member

mowies commented Mar 5, 2024

That should be ok since KeptnTasks are not really created by users that ofter, only in very specific corner cases. I think that was intended.

@mowies mowies removed this from the 2.0.0-rc.1 milestone Mar 5, 2024
@mowies mowies moved this to 🎟️ Refined in Keptn Lifecycle Toolkit Mar 5, 2024
@mowies mowies moved this from 🎟️ Refined to 🏃 In progress in Keptn Lifecycle Toolkit Mar 5, 2024
@odubajDT
Copy link
Contributor

odubajDT commented Mar 6, 2024

Closing, as the linked PR was merged

@odubajDT odubajDT closed this as completed Mar 6, 2024
@github-project-automation github-project-automation bot moved this from 🏃 In progress to ✅ Done in Keptn Lifecycle Toolkit Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
Archived in project
Development

No branches or pull requests

3 participants