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

4.x: Config reference documentation #9053

Merged
merged 6 commits into from
Jul 31, 2024

Conversation

tomas-langer
Copy link
Member

@tomas-langer tomas-langer commented Jul 29, 2024

Resolves #9036
Resolves #7791

Please review by commits. The last one changes all of the generated files (mostly whitespace changes), so it looks big...

Config reference documentation updates:

  1. config-metadata module is re-structured, as it now has multiple child modules; I did not change group id of existing modules for backward compatibility; introduced codegen and docs modules, deprecated processor module
  2. Fix to all pom files to use codegen, add plugin dependencies to correctly order Maven reactor, remove processor dependencies from regular Maven dependencies etc.
  3. Update to docs pom file, to generate the config reference documentation with profile configdocs
  4. Update to the actual .adoc files based on all of the above

This is a preparation to remove all config reference docs from github repo if desired - we can generate it together with javadocs when building documentation (which would be a similar style to generate all of our docs directly from source material, rather than from intermediately generated files)

@tomas-langer tomas-langer added this to the 4.1.0 milestone Jul 29, 2024
@tomas-langer tomas-langer self-assigned this Jul 29, 2024
@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Jul 29, 2024
- introduction of codegen module (replaces processor)
- introduction of docs module (to generate documentation from metadata JSON)
- deprecated processor
- updated docs and moved it from docs-internal

Updates to bom pom, and all pom
- fixed plugin dependencies
- fixed that dependency for config metadata is always optional
- removed dependencies on annotation processors from dependency sections
- introducing profile to update config reference documentation
- introducing updated readme (moved from internal docs)
- a few docs fixes in classes discovered when testing
…rom git).

Using template for config_reference.
@tomas-langer
Copy link
Member Author

Rebased to resolve conflict with changes done by Metrics

@tomas-langer tomas-langer merged commit 1cad377 into helidon-io:main Jul 31, 2024
12 checks passed
@tomas-langer tomas-langer deleted the 9036-config-docs-2 branch July 31, 2024 22:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4.x Version 4.x config-metadata OCA Verified All contributors have signed the Oracle Contributor Agreement.
Projects
None yet
3 participants