Skip to content

batch.adoc: broken API links #40039

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

Closed
commonquail opened this issue Mar 20, 2024 · 5 comments
Closed

batch.adoc: broken API links #40039

commonquail opened this issue Mar 20, 2024 · 5 comments
Labels
status: superseded An issue that has been superseded by another

Comments

@commonquail
Copy link

The Spring Boot 3.2.3 reference documentation's section 18.12.1 Specifying a Batch Data Source, which lives in howto/batch.adoc, attempts to link to Spring Batch's Javadoc for @EnableBatchProcessing and DefaultBatchConfiguration. However, the generated URLs are

where instead the common prefix should have been https://docs.spring.io/spring-batch/docs/5.1.1/api/. The /api/ segment appears to be missing from asciidoc/attributes.adoc's :spring-batch-api: attribute.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Mar 20, 2024
@scottfrederick scottfrederick added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Mar 20, 2024
@scottfrederick scottfrederick added this to the 3.2.x milestone Mar 20, 2024
@scottfrederick scottfrederick added status: on-hold We can't start working on this issue yet status: blocked An issue that's blocked on an external project change and removed status: blocked An issue that's blocked on an external project change labels Mar 20, 2024
@scottfrederick
Copy link
Contributor

scottfrederick commented Mar 20, 2024

The links are broken starting with 3.2.x. Marking this as on-hold for now as we don't want to introduce documentation changes until the Antora migration is complete.

@mhalbritter mhalbritter removed the status: on-hold We can't start working on this issue yet label Mar 22, 2024
@mhalbritter
Copy link
Contributor

Antora migration complete.

@nahidshahin
Copy link

@nahidshahin
Copy link

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

@scottfrederick
Copy link
Contributor

Closing in favor of #40141

@scottfrederick scottfrederick closed this as not planned Won't fix, can't repro, duplicate, stale Apr 3, 2024
@scottfrederick scottfrederick added status: superseded An issue that has been superseded by another and removed type: documentation A documentation update labels Apr 3, 2024
@scottfrederick scottfrederick removed this from the 3.2.x milestone Apr 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: superseded An issue that has been superseded by another
Projects
None yet
Development

No branches or pull requests

5 participants