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 the plugin registry list to a different format #21

Open
4 tasks
fzipi opened this issue Apr 2, 2024 · 3 comments
Open
4 tasks

Move the plugin registry list to a different format #21

fzipi opened this issue Apr 2, 2024 · 3 comments
Labels
enhancement New feature or request

Comments

@fzipi
Copy link
Member

fzipi commented Apr 2, 2024

While having the list in the readme is easy to read, it is not easy to consume from other sites (website, documentation, etc.).

We should think on a way to manage the list using yaml for example, and generating the README.md file using a custom github action.

Requirements

  • have a readme skeleton where the table will be placed
  • create github action for post-processing yaml plugin list
  • process the yaml content and insert the table into the markdown file
  • commit the file in the GHA
@fzipi fzipi added the enhancement New feature or request label Apr 2, 2024
@RedXanadu
Copy link
Member

RedXanadu commented Apr 10, 2024

Do we want this?

Having it as human-readable text makes it easy to edit and update. Almost no presumed knowledge or skills are required, which is a good thing.

If the plugin registry contained info like version numbers, releases etc. then I would agree having it machine-readable would be a benefit. But we don't store that sort of information here. Unless that is part of the plan?

@fzipi
Copy link
Member Author

fzipi commented Apr 11, 2024

We need to consume the registry data in other places. I don't think parsing html would do no good.

But we always could just forget about this, and in the future someone will take care of keeping things up to date across repos 🤷 .

@dune73
Copy link
Member

dune73 commented Apr 12, 2024

We're currently doing a markdown table. I guess converting that automatically to a yaml format would be doable, but a bit brittle.

So writing the yaml and then generating the markdown would be better still human readable from my perspective. As long as it's not xml, we should be find.

@RedXanadu Is yaml really such a no-go? If yes, I can do the shell one-liner to do markdown -> yaml.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants