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

Add version, edition and similar badges as a simple markdown element that can be added within any page #1953

Open
anna-geller opened this issue Nov 14, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation kind/website Website-related change

Comments

@anna-geller
Copy link
Member

anna-geller commented Nov 14, 2024

Issue description

Problem

Similar to: https://kestra.io/docs/enterprise/worker-group
image

We want to be able to add similar badges:

editions: ["EE"]
version: ">= 0.10.0"

However, instead of defining those in frontmatter, we could add them inline anywhere within the markdown page as follows (just example, up to the person who picks it up to determine how best to implement it):

::badge
editions: ["EE"]
version: ">= 0.10.0"
::

Context

The goal is allowing certain subsections to be related to a given Kestra version or edition. For example, we may have introduced a feature such as worker group in v0.10, but in v0.19 we introduced a dedicated UI page for creating worker groups and in v0.20 we're also adding functionality to specify fallback behavior configuring what should happen with a taskrun if the assigned worker group has no active workers polling for work.

Complexity

We can focus on adding this on the website, but we need to keep in mind that this will have to also work within in-app docs, so the required changes need to be included in the UI.

@anna-geller anna-geller added the kind/website Website-related change label Nov 14, 2024
@kestrabot kestrabot bot added this to Issues Nov 14, 2024
@github-project-automation github-project-automation bot moved this to Backlog in Issues Nov 14, 2024
@anna-geller anna-geller added the documentation Improvements or additions to documentation label Nov 14, 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 kind/website Website-related change
Projects
Status: Backlog
Development

No branches or pull requests

2 participants