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

Links to Spring Batch javadoc for EnableBatchProcessing and DefaultBatchConfiguration are broken #40141

Conversation

nahidshahin
Copy link

@nahidshahin nahidshahin commented Mar 31, 2024

Fixed broken API links in batch.adoc

This is a fix for #40039

In main branch I found /api/ is there but /org/springframework/batch is missing. Check:
https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot-dependencies/build.gradle#L1824

So the broken URL was like: https://docs.spring.io/spring-batch/docs/5.1.1/api/core/configuration/annotation/EnableBatchProcessing.html

This PR fixed the issue in main branch, I tested locally. Thanks

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Mar 31, 2024
@scottfrederick scottfrederick added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Apr 3, 2024
@scottfrederick scottfrederick added this to the 3.2.x milestone Apr 3, 2024
@scottfrederick
Copy link
Contributor

This will need a different fix for 3.2.x, which doesn't have the build metadata for links.

@scottfrederick scottfrederick added the for: merge-with-amendments Needs some changes when we merge label Apr 3, 2024
@nahidshahin
Copy link
Author

@scottfrederick what if I change the batch.adoc itself? Please check b6d9110
Thanks

@scottfrederick
Copy link
Contributor

@nahidshahin I do think having just up to the /api part of the URL in the build metadata, and the org/springframework/batch part in the adoc file, is better. The bigger issue is that the location of these adoc files and the way we set up the base URLs has changed recently as part of the move to Antora-based documentation. We want to fix this issue starting in Spring Boot 3.2 and the forward-merge it to the latest branch, so we'll essentially have to make two different changes. We can handle that as part of our merging process, so nothing more for you to do there. Thanks!

@wilkinsona wilkinsona changed the title Fixed broken API links in batch.adoc Links to Spring Batch javadoc for EnableBatchProcessing and DefaultBatchConfiguration are broken Apr 22, 2024
@wilkinsona wilkinsona self-assigned this Apr 22, 2024
@wilkinsona wilkinsona removed the for: merge-with-amendments Needs some changes when we merge label Apr 22, 2024
@wilkinsona wilkinsona modified the milestones: 3.2.x, 3.3.x, 3.3.0 Apr 22, 2024
wilkinsona pushed a commit that referenced this pull request Apr 22, 2024
@wilkinsona
Copy link
Member

Thanks very much, @nahidshahin.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants