grails-core groovydoc duplication for grails-data
- Dominant language
- Groovy
- Stars
- 2.9k
- Forks
- 975
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 92
Description
### Issue description
If we remove the extra groovydocs from grails-data they would need to be done as part of https://github.com/apache/grails-core/issues/14990
/api/ has groovydocs for everything in grails-core including grails-data.
Duplicated Groovydocs for grails-data exist in the combined /api/ and a second location:
grails-data/api
grails-data/hibernate5/api
grails-data/mongodb/api
https://docs.grails.org/snapshot/api/
https://docs.grails.org/snapshot/grails-data/api/
https://docs.grails.org/snapshot/grails-data/hibernate5/api/
https://docs.grails.org/snapshot/grails-data/mongodb/api/
everything else, which was consolidated into grails core, only exists in /api/.
`grails-gradle` and `grails-forge`, are separate Gradle projects are not included. https://github.com/apache/grails-core/issues/14978 & https://github.com/apache/grails-core/issues/14996
Contributor guide
Research direction
Start by reading issue #14990 and comparing the documented paths under /api/, grails-data/api, grails-data/hibernate5/api, and grails-data/mongodb/api. Verify how the Groovydoc output is generated, then confirm that grails-data appears only in the consolidated /api/ while grails-gradle and grails-forge remain excluded.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- groovy
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100