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

Mentioning AbstractAuditable in documentation [DATACMNS-1547]

Open
#1,974 0 comments 0 reactions 1 assignee View on GitHub

@odrotbohm is already working on this.

Since Dec 30, 2020.

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

Description

gavvvr opened DATACMNS-1547 and commented

Hi. I was reading Data JDBC docs and was unable to find any AbstractAuditable while reading this:

 

There is also a convenience base class, AbstractAuditable, which you can extend to avoid the need to manually implement the interface methods. Doing so increases the coupling of your domain classes to Spring Data, which might be something you want to avoid. Usually, the annotation-based way of defining auditing metadata is preferred as it is less invasive and more flexible.

I wanted to create a PR removing this paragraph from Data Jdbc docs, but it turns out being imported from data commons docs:

include::{spring-data-commons-docs}/auditing.adoc[leveloffset=+1]

Looks like AbstractAuditable only exists in Data JPA module. So, consider removing this paragraph from Data Commons docs or change it to be clearer for user that the class exists only in specific module


Referenced from: commits https://github.com/spring-projects/spring-data-commons/commit/c42f5efe0185ce30d2ff79c1de2d01002bb00f28, https://github.com/spring-projects/spring-data-commons/commit/a50ee6c3dffbe217d44cfcd3b243d7952b5dc8fd

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.