spring-projects / spring-projects/spring-data-commons

Discontinue rebundling commons reference documentation in implementation projects

Open
#2,489 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

type: documentation
Dominant language
Java
Stars
838
Forks
730
PR merge metrics
No merged PRs in 30d

Description

I hate this, I kind of get why it's done but what's happening is confusion of what's actually supported in these projects, has a lot of this documentation says it's dependent on the implementation. Then the implementation doesn't actually mention what supported. I think it would be better to have some way that their documentation can either bundle only the parts they support or link back to only the parts they support.

For example I raised the question, And have asked for further documentation in neo4j of whether the Geo types are actually supported. I really couldn't tell from the reference documentation. Source diving shouldn't be required. Back in the day I had similar problem with neo4j and support for Optional. It could have course be argued that some of this is simply a problem with spring data in neo4j, I'm not sure, but I could see how it would easily be ignored to document that stuff since it's bundled in a sense.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not name files, tests, or an entry point. Start by tracing how Spring Data Commons reference documentation is rebundled into implementation projects, then compare the Neo4j documentation with the support it actually provides. Done means defining and documenting a clear way for each implementation to expose only supported reference content or link to it explicitly.

Written by the indexing model from the issue text.

Assessment

Tech stack
neo4j
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.