Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ambiguous description of Configuring a JobRepository #4333

Closed
sppfly opened this issue Mar 23, 2023 · 2 comments
Closed

Ambiguous description of Configuring a JobRepository #4333

sppfly opened this issue Mar 23, 2023 · 2 comments

Comments

@sppfly
Copy link

sppfly commented Mar 23, 2023

Bug description

The description of required configuration options of Configuring a JobRepository in this chapter is ambiguous. We don't know whether id is required or dataSource and transactionManager are required.

image

@sppfly sppfly added status: waiting-for-triage Issues that we did not analyse yet type: bug labels Mar 23, 2023
@fmbenhassine fmbenhassine added in: documentation and removed status: waiting-for-triage Issues that we did not analyse yet labels Apr 3, 2023
@fmbenhassine fmbenhassine added this to the 5.0.2 milestone Apr 3, 2023
@fmbenhassine fmbenhassine modified the milestones: 5.0.2, 5.1.0 May 17, 2023
@fmbenhassine
Copy link
Contributor

Thank you for reporting this issue. It seems you have selected "Both" in the toggle of Java/XML configuration styles at the top of the page. When "Both" is selected, the text is indeed confusing (in this section and in other sections as well).

For this reason, the option "Both" was removed in the new documentation: https://docs.spring.io/spring-batch/reference/job/configuring-repository.html .The toggle is now next to each example, and the confusing "Both" option was removed. That said, the content of the Java sample needs to be updated to be equivalent to the XML one.

@fmbenhassine fmbenhassine changed the title Doc issue: ambiguous description of Configuring a JobRepository Ambiguous description of Configuring a JobRepository Sep 8, 2023
@fmbenhassine fmbenhassine modified the milestones: 5.1.0, 5.1.0-M3 Sep 8, 2023
@sppfly
Copy link
Author

sppfly commented Sep 8, 2023

It's not ambiguous now, thanks for your work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants