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 the documentation of the website to highlight the new task runtimes #1489

Closed
4 tasks
Tracked by #614
RealAnna opened this issue May 30, 2023 · 2 comments
Closed
4 tasks
Tracked by #614
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@RealAnna
Copy link
Contributor

RealAnna commented May 30, 2023

The Write KeptnTask page of our website should reflect the new possibility of defining tasks using other containers' runtime.

DoD

  • Mention the limitation about a single runtime per task
  • Write inside the KeptnTask page a section for each available runtime, namely container and Python
  • Each section provides one or more tested examples
  • Each section specifies from what version the runtime is available (aka container and python should be from 0.8 onward) - check if it makes sense based on the "version" drop-down menu
@RealAnna RealAnna added operator documentation Improvements or additions to documentation labels May 30, 2023
@RealAnna RealAnna changed the title Update the documentations of the website to map the new task truntimes Update the documentation of the website to highlight the new task runtimes May 30, 2023
@RealAnna RealAnna added this to the 0.8 milestone May 30, 2023
@RealAnna RealAnna added the status: ready-for-refinement Issue is relevant for the next backlog refinment label May 30, 2023
@thisthat thisthat moved this to 🎟️ Refined in Keptn Lifecycle Toolkit May 30, 2023
@thisthat thisthat removed the status: ready-for-refinement Issue is relevant for the next backlog refinment label May 30, 2023
@StackScribe
Copy link
Contributor

The "Write Keptn Tasks" page has been removed from the doc set. This information should be added to the following docs:

  • KeptnTaskDefinition CRE YAML reference page -- this is where the information you list here needs to go
  • Working with Keptn Tasks -- should be a "guide" to workng with Keptn tasks. Right now, it is kind of a catch-all for information that is related. It needs some rewrite and restructuring and we may end up breaking it up into smaller pages. But if we have information to impart that is not appropriate for the reference page, we can put it here or in its own page in the "Implementing..." section
  • KeptnTaskDefinition API Reference Page -- yes, this is autogenerated but we shouldn't forget about it. I assume that this change warrants the creation of a v1alpha4 API version.

@RealAnna
Copy link
Contributor Author

closed in favor of #1521 and #1579

@github-project-automation github-project-automation bot moved this from 🎟️ Refined to ✅ Done in Keptn Lifecycle Toolkit Jul 12, 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
Development

No branches or pull requests

3 participants