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 a section with our rule repository #32

Open
2 of 4 tasks
utarwyn opened this issue Nov 6, 2024 · 0 comments · May be fixed by #22
Open
2 of 4 tasks

Add a section with our rule repository #32

utarwyn opened this issue Nov 6, 2024 · 0 comments · May be fixed by #22
Labels
epic This issue represents an epic 🚀 enhancement New feature or request

Comments

@utarwyn
Copy link
Member

utarwyn commented Nov 6, 2024

Our rules are currently defined and presented as a Markdown table in the ecoCode repository. Although this centralizes the rules, they are still too hidden and poorly presented in an unclear table. What's more, we have to update it manually! So many possible inconsistencies.

To showcase all our painstaking work and make the rules available to as many people as possible, we need to present them in a different form. That's where a new section on the site comes in! 🔥

Important features are:

  • List of all rules in the main repository (can be filtered/sorted by technologies, severity)
  • Detail of all rules with descriptions, infos and references
  • Automatically updated to avoid inconsistencies

Let's get down to a bit of architecture!

This schema briefly presents the idea and how the repositories will communicate with each other (in french).

image

This EPIC can be splitted into small tasks:

  • 1. Check the technical feasibility of integration with the tool
  • 2. Web and mobile design
  • 3. Create the automated task to build rule metadatas
  • 4. Website integration
@utarwyn utarwyn added 🚀 enhancement New feature or request epic This issue represents an epic labels Nov 6, 2024
@utarwyn utarwyn linked a pull request Nov 6, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
epic This issue represents an epic 🚀 enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant