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

Extract recurring asciidoc links to attributes #31619

Merged
merged 8 commits into from Nov 21, 2023

Conversation

simonbasle
Copy link
Contributor

@simonbasle simonbasle commented Nov 17, 2023

This commit extracts Spring-related links and recurring external links into asciidoctor attributes to be used by the Antora toolchain.

It notably homogenizes links to:

  • IETF RFCs
  • Java Community Process JSRs
  • Java API Documentation (Java 17 version)
  • Kotlin documentation (Kotlinlang.org version)
  • the Spring Boot reference guide (html version)

This commit also reworks most link attributes to follow a Project-Category-Misc syntax. For example, spring-boot-docs rather than docs-spring-boot.

Closes gh-26864

This commit extract spring-related links and recurring
external links into asciidoctor attributes to be used
by the Antora toolchain.

It notably homogenizes links to:
 - IETF RFCs
 - Java Community Process JSRs
 - the Java API Documentation (on the Java 17 version)
 - Kotlin documentations (on the Kotlinlang.org version)
 - the Spring Boot reference guide (on the `html` version)

This commit also reworks most link attributes to follow
a Project-Category-Misc syntax. For example, spring-boot-docs rather than docs-spring-boot.

Closes spring-projectsgh-26864
@simonbasle simonbasle added the type: documentation A documentation task label Nov 17, 2023
@simonbasle simonbasle added this to the 6.1.x milestone Nov 17, 2023
@simonbasle simonbasle requested a review from a team November 17, 2023 12:29
Copy link
Member

@bclozel bclozel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for putting this together, this is solving quite a few consistency issues and will make the docs much easier to maintain!

@jhoeller
Copy link
Contributor

Looks good to me as well! Let's do this for 6.1.1 right away.

@jhoeller jhoeller modified the milestones: 6.1.x, 6.1.1 Nov 17, 2023
Copy link
Member

@snicoll snicoll left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Member

@sbrannen sbrannen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is much needed.

Thanks so much for taking this on! 👏

I've left a few questions.

framework-docs/antora.yml Outdated Show resolved Hide resolved
framework-docs/antora.yml Outdated Show resolved Hide resolved
framework-docs/antora.yml Show resolved Hide resolved
framework-docs/modules/ROOT/pages/attributes.adoc Outdated Show resolved Hide resolved
@simonbasle
Copy link
Contributor Author

the only thing in the deleted asciidoc folder that could be of later use is the (as of now unsupported in antora toolchain) anchor-rewrite.properties file

@simonbasle simonbasle merged commit 8567402 into spring-projects:main Nov 21, 2023
2 checks passed
@simonbasle simonbasle deleted the asciidocAttributes branch November 21, 2023 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use asciidoc attributes in reference documentation
5 participants