kestra-io / docs

Documentation for Kestra — an event-driven, language-agnostic orchestration and scheduling platform to manage millions of workflows declaratively in code.
https://kestra.io/docs
80 stars 91 forks source link

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

Open anna-geller opened 3 days ago

anna-geller commented 3 days ago

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.