jakartaee / jakartaee/validation-spec
We need to modernize the specification doc build
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 23
- Forks
- 22
- PR merge metrics
- No merged PRs in 30d
Description
The current spec document build is based on ant and the asciidoctor ant plugin. The ant plugin has not been updated in 5 years, and we are using an even older version of it. Even just updating to the 5 year old version of the ant plugin causes the generation to fail because the custom Hibernate tree/block asciidoc plugins are apparently incompatible with that version.
We should look at switching the generation to the maven plugin, but this will probably still require updates to the hibernate-asciidoctor-extensions.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Ant-based specification document build and its asciidoctor Ant plugin configuration, then inspect the custom Hibernate tree/block asciidoc plugins. Evaluate the Maven plugin path and the hibernate-asciidoctor-extensions compatibility; done means the specification generation succeeds with the modernized build.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- build-system, documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100