Skip to content

Fix Antora cross-references that lead to other pages. #10345

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

Merged
merged 1 commit into from
Oct 6, 2021
Merged

Fix Antora cross-references that lead to other pages. #10345

merged 1 commit into from
Oct 6, 2021

Conversation

ahus1
Copy link
Contributor

@ahus1 ahus1 commented Oct 5, 2021

Also using AsciiDoc style listings instead of Markdown style listings, and using explicit section IDs on all cross-references.

Background: I'm maintaining the IntelliJ AsciiDoc plugin that also supports Antora. When I publish new releases, I sometimes pick some public AsciiDoc/Antora documentation and run the plugin's validations.
Some minor left-overs of the conversion showed up, and I submitted a PR.

Thanks for providing this this project including its docs!

Also using AsciiDoc style listings instead of Markdown style listings, and using explicit section IDs on all cross-references.
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Oct 5, 2021
@jzheaux
Copy link
Contributor

jzheaux commented Oct 6, 2021

Hi, @ahus1, thanks for the improvements!

If I understand correctly, it would make sense to backport the section id and AsciiDoc style listing changes.

Since Antora is not used on earlier versions, I don't think it makes sense to backport those changes. Would you agree? If so, will you please separate those into two commits so that we can more easily backport the other improvements?

@jzheaux jzheaux self-assigned this Oct 6, 2021
@jzheaux jzheaux added in: docs An issue in Documentation or samples type: enhancement A general enhancement and removed status: waiting-for-triage An issue we've not yet triaged labels Oct 6, 2021
@jzheaux jzheaux added this to the 5.6.0-RC1 milestone Oct 6, 2021
@ahus1
Copy link
Contributor Author

ahus1 commented Oct 6, 2021

@jzheaux - TL;DR: I don't think anything in this PR should backported as the two changes about ID and listing style are only a refactoring that produces the same output as before:

  1. Asciidoctor understands both the AsciiDoc and Markdown syntax for listings, and it generates the same output.
  2. the section IDs work with implicit section IDs in 5.5.x (and they would work with Antora as well). Again, it is just a refactoring towards AsciiDoc best practices, as it guards you from broken references when headings change. It generates the output as before.

Still, if you insist, I'm happy to split this PR, or (preferred) submit another PR for 5.5.x with only the ID and listing changes.

@jzheaux jzheaux merged commit f561499 into spring-projects:main Oct 6, 2021
@jzheaux
Copy link
Contributor

jzheaux commented Oct 6, 2021

Perfect, thanks for the clarification, @ahus1. This is now merged into main.

@ahus1 ahus1 deleted the cleanup-references-for-antora branch October 6, 2021 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: docs An issue in Documentation or samples type: enhancement A general enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants