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

feat: automatically produce the configuration documentation #2538

Open
mauromorales opened this issue May 7, 2024 · 1 comment
Open

feat: automatically produce the configuration documentation #2538

mauromorales opened this issue May 7, 2024 · 1 comment
Labels
enhancement New feature or request triage Add this label to issues that should be triaged and prioretized in the next planning call

Comments

@mauromorales
Copy link
Member

Right now this page https://kairos.io/docs/reference/configuration/ describes all the possible configurations in Kairos. The content is written manually so it's easy that some configuration options are outdated, or that new ones are added but don't comply with the validator for example.

I would like to have a system that knowing the kairos version, it will produce all the actual possible configurations that system can have. If something is missing, it needs to be added to the single source of truth, if something is not supposed to be there, it needs to be removed from the single source of truth.

@mauromorales mauromorales added enhancement New feature or request triage Add this label to issues that should be triaged and prioretized in the next planning call labels May 7, 2024
@ci-robbot ci-robbot added the question Further information is requested label May 7, 2024
@ci-robbot
Copy link
Collaborator

Hello mauromorales, thank you for your suggestion. In order to properly address your proposal, we need more information regarding the approach you are suggesting for automatically generating the configuration documentation. Could you please provide more details about the method or tool you would like to use for this process?

Additionally, could you specify which version(s) of Kairos your proposal focuses on? This will help ensure the solution is applicable to the specific versions you have in mind.

Kindly provide this information so that we can better understand your proposal and proceed with the necessary evaluation and triage. Remember, this is an automated response; I am not capable of providing solutions, but I can help guide you through the process.

Thank you for your contribution to the project. I am a bot, an experiment of @mudler and @jimmykarily, here to assist with issue triage.

@mauromorales mauromorales removed the question Further information is requested label May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request triage Add this label to issues that should be triaged and prioretized in the next planning call
Projects
Status: No status
Development

No branches or pull requests

2 participants