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

Update automations for new docs system #3991

Open
JonasKunz opened this issue Mar 5, 2025 · 0 comments
Open

Update automations for new docs system #3991

JonasKunz opened this issue Mar 5, 2025 · 0 comments

Comments

@JonasKunz
Copy link
Contributor

With #3981 we'll switch from the asciidoc based docs system to markdown. We'll have to revisit our automations:

  • We previously generated the asciidoc and reference properties file automatically from our config option declarations in the code: We need to evaluate how we want to move forward here: Do we want to spend the effort on adding the same automation for markdown or do we add this as a manual task to our PR templates?
  • [docs] Migrate docs from AsciiDoc to Markdown #3981 also disabled the ConfigurationExporterTest verifying the docs match the config options declared in the code. Based on what we decide for the point above, we'll need to update or remove this test accordingly
  • Our release relies on an automation to update the changelog in the docs. This needs to be updated/fixed prior to the next release.

At least the last point must be tackled soon, because it otherwise would block us from releasing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant