spring-projects / spring-projects/spring-data-rest
Update documentation to HAL Explorer
Open
Nobody has claimed this yet.
status: ideal-for-contribution
type: documentation
- Dominant language
- Java
- Stars
- 958
- Forks
- 568
- PR merge metrics
- No merged PRs in 30d
Description
While the HAL Browser module was removed and replaced by HAL Explorer, both the readme of this project and the Spring Data REST reference documentation still refer to the HAL Browser. Please update the doc to refer to HAL Explorer.
If it would help, I could contribute to that.
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
Search the project README and the Spring Data REST reference documentation for references to HAL Browser. Update those references to HAL Explorer, then verify that the outdated name no longer appears in the documented locations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100