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

Generate config docs during build #9103

Conversation

romain-grecourt
Copy link
Contributor

Description

Generate config docs during build

  • Inline io_helidon_microprofile_lra_Coordinator.adoc in mp/lra.adoc
  • Delete all generated config docs
  • Add a .gitignore under docs to ignore src/main/asciidoc/config
  • Execute the config doc generator by default
  • Configure the default-clean execution to remove src/main/asciidoc/config/**/*
  • Remove configdocs profile
  • Configure compiler-plugin to disable removal warning
  • Update ConfigDocs (generator) to create the target directory if it does not exist

Fixes #9056

Documentation

None.

- Inline io_helidon_microprofile_lra_Coordinator.adoc in mp/lra.adoc
- Delete all generated config docs
- Add a .gitignore under docs to ignore src/main/asciidoc/config
- Execute the config doc generator by default
- Configure the default-clean execution to remove src/main/asciidoc/config/**/*
- Remove configdocs profile
- Configure compiler-plugin to disable removal warning
- Update ConfigDocs (generator) to create the target directory if it does not exist

Fixes helidon-io#9056
@romain-grecourt romain-grecourt added docs 4.x Version 4.x labels Aug 5, 2024
@romain-grecourt romain-grecourt added this to the 4.1.0 milestone Aug 5, 2024
@romain-grecourt romain-grecourt self-assigned this Aug 5, 2024
@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Aug 5, 2024
@romain-grecourt romain-grecourt merged commit 7c05a74 into helidon-io:main Aug 6, 2024
13 checks passed
@romain-grecourt romain-grecourt deleted the generate-config-docs-in-build branch August 6, 2024 00:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4.x Version 4.x docs OCA Verified All contributors have signed the Oracle Contributor Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4.x: FIx LRA Coordinator config reference documentation
2 participants