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

Move each plugin index page from Markdown to model-based doc #1503

Open
7 tasks done
brian-mulier-p opened this issue Jun 25, 2024 · 3 comments
Open
7 tasks done

Move each plugin index page from Markdown to model-based doc #1503

brian-mulier-p opened this issue Jun 25, 2024 · 3 comments
Assignees
Labels
area/plugin Plugin-related issue or feature request documentation Improvements or additions to documentation

Comments

@brian-mulier-p
Copy link
Member

brian-mulier-p commented Jun 25, 2024

Issue description

Currently the index of each plugin where for a given plugin we list every tasks / triggers / ... it includes (here) is a bit ugly. The goal is to move from an API-generated markdown page to a model-based generation. Basically the front-end will instead fetch the model data and will generate the page.

It will allow us to easily modify the content and introduce in an easier manner custom components.

What to do to achieve such result:

  • for now, call the /v1/plugins API that will return every tasks of every plugins (a filtered endpoint will be added later)
  • filter by name === slug
  • cutoff all tasks / triggers / conditions (everything that is a list except aliases that you don't include) by the group property (so for snowflake it's io.kestra.plugin.jdbc.snowflake for eg.)
  • split everything by dot
  • keep the last word after dot as the task name (so the link one)
  • recursively indent with 1 category per word ahead of the task name
  • group them if they have similar categories
@github-project-automation github-project-automation bot moved this to Backlog in Issues Jun 25, 2024
@anna-geller anna-geller moved this from Backlog to In review in Issues Jun 27, 2024
@tchiotludo tchiotludo removed the website label Jul 6, 2024
@anna-geller anna-geller added the documentation Improvements or additions to documentation label Jul 8, 2024
@anna-geller
Copy link
Member

anna-geller commented Jul 8, 2024

@brian-mulier-p I see everything is checked :) can the issue be closed?

@t-chatoyan
Copy link
Contributor

#1510
kestra-io/ui-libs#37

@brian-mulier-p
Copy link
Member Author

Waiting for a Cloudflare ticket due to building issue

@anna-geller anna-geller added the area/plugin Plugin-related issue or feature request label Oct 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/plugin Plugin-related issue or feature request documentation Improvements or additions to documentation
Projects
Status: In review
Development

No branches or pull requests

4 participants