apache / apache/grails-core

Fix broken links in grails-data/gorm documentation

Open
#14,990 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Groovy
Stars
2.9k
Forks
975
Avg merge
1d 22h
Merged PRs (30d)
92

Description

### Issue description

Broken links can be identified and verified as fixed using https://github.com/lycheeverse/lychee/releases/.

```
./gradlew grails-doc:build
cd \grails-doc\build\docs\grails-data
lychee-x86_64-windows.exe . --format markdown --output results.md --exclude-path api --exclude-path grails-data/hibernate5/api --exclude ".*.css$" --exclude "^http://localhost"
```

review `results.md`

Contributor guide

Open the contributing guide

Research direction

Build the documentation with ./gradlew grails-doc:build, then run lychee against grails-doc/build/docs/grails-data using the exclusions and output settings in the issue. Review results.md, update the documentation links reported there, and rerun the check until the broken links are fixed.

Written by the indexing model from the issue text.

Assessment

Tech stack
groovy
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.