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.

Sign up for GitHub

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

Jump to bottom

Use asciidoc attributes in reference documentation #26864

Closed
snicoll opened this issue Apr 27, 2021 · 1 comment · Fixed by #31619
Closed

Use asciidoc attributes in reference documentation #26864

snicoll opened this issue Apr 27, 2021 · 1 comment · Fixed by #31619
Assignees
@simonbasle
Labels
status: superseded An issue that has been superseded by another type: documentation A documentation task

Comments

@snicoll
Copy link
Member

snicoll commented Apr 27, 2021

There are a number of places where links could use an attribute to rationalize what we use and make sure they are consistent.
@snicoll snicoll added the type: documentation A documentation task label Apr 27, 2021
@snicoll snicoll added this to the 5.x Backlog milestone Apr 27, 2021
@snicoll snicoll self-assigned this Apr 27, 2021
@jhoeller jhoeller modified the milestones: 6.x Backlog, 6.0.x Nov 11, 2021
@jhoeller jhoeller modified the milestones: 6.0.x, 6.1.x Feb 14, 2023
@snicoll snicoll modified the milestones: 6.1.x, 6.x Backlog Oct 12, 2023
@snicoll snicoll removed their assignment Nov 7, 2023
@simonbasle simonbasle self-assigned this Nov 17, 2023
simonbasle added a commit to simonbasle/spring-framework that referenced this issue Nov 17, 2023
@simonbasle
Extract recurring asciidoc links to attributes
1f9b099 
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 mentioned this issue Nov 17, 2023
Merged
@jhoeller jhoeller added the status: superseded An issue that has been superseded by another label Nov 17, 2023
@jhoeller jhoeller removed this from the 6.x Backlog milestone Nov 17, 2023
@jhoeller
Copy link
Contributor

Superseded by PR #31619.

@snicoll snicoll closed this as not planned Won't fix, can't repro, duplicate, stale Nov 17, 2023
simonbasle added a commit that referenced this issue Nov 21, 2023
@simonbasle
Extract recurring asciidoc links to attributes, cleanup old doc files
8567402 
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`.

Finally, it makes an effort to clean up remainders from the previous
documentation toolchain, namely the `docs/asciidoc` folder and 
`modules/ROOT/pages/attributes.adoc` file.

Closes gh-26864
Closes gh-31619
@simonbasle simonbasle closed this as not planned Won't fix, can't repro, duplicate, stale Nov 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@simonbasle simonbasle

Labels
status: superseded An issue that has been superseded by another type: documentation A documentation task
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Extract recurring asciidoc links to attributes simonbasle/spring-framework
3 participants
@snicoll @jhoeller @simonbasle