Skip to content

Switch to Antora Based Documentation #33766

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
Closed
15 tasks done
rwinch opened this issue Jan 11, 2023 · 0 comments
Closed
15 tasks done

Switch to Antora Based Documentation #33766

rwinch opened this issue Jan 11, 2023 · 0 comments
Labels
type: documentation A documentation update
Milestone
3.3.0-M3

Comments

@rwinch
Copy link
Member

rwinch commented Jan 11, 2023 •
edited by philwebb
Loading

Similar to Spring Security, Spring Session, and Spring Framework, Spring Boot should consider switching Antora Based Documentation.

A work in progress can be found at https://rwinch.github.io/spring-boot/boot/ and the source in https://github.com/rwinch/spring-boot/tree/antora

  • Rebase the PR
  • Switch to docsearch
  • Verify extension use aligns with production Antora projects
  • Migrate Maven Plugin docs
  • Migrate Gradle Plugin docs
  • Migrate Actuator docs
  • Verify build files align with production Antora projects
  • Review
    • Do configprops work?
    • Does ID validation work?
    • Was it migrated to Asciidoctor tabs?
    • Have [null] references been fixed
    • Disable docs flag on zip
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jan 11, 2023
@philwebb philwebb added type: task A general task and removed status: waiting-for-triage An issue we've not yet triaged labels Jan 11, 2023
@philwebb philwebb added this to the 3.x milestone Jan 11, 2023
@rwinch rwinch moved this to Planning in Spring Security Team Jan 11, 2023
@wilkinsona wilkinsona added type: documentation A documentation update and removed type: task A general task labels Jan 12, 2023
@philwebb philwebb mentioned this issue Aug 16, 2023
Closed
@wilkinsona wilkinsona modified the milestones: 3.x, 3.3.x Feb 1, 2024
@wilkinsona wilkinsona mentioned this issue Feb 9, 2024
Closed
@scottfrederick scottfrederick mentioned this issue Mar 20, 2024
Closed
philwebb added a commit that referenced this issue Mar 20, 2024
@philwebb
Stop publishing documentation from CI
d18f60e 
Remove upload attributes to prevent zip documentation from being
deployed.

See gh-33766
philwebb added a commit that referenced this issue Mar 20, 2024
@philwebb
Prepare buildSrc for migration to Antora
8d64e99 
Replace `AsciidoctorConventions` with `AntoraConventions` in
preparation for the migration to Antora.

See gh-33766
philwebb added a commit that referenced this issue Mar 20, 2024
@philwebb
Migrate actuator-autoconfigure to Antora
f35d6b6 
See gh-33766
philwebb added a commit that referenced this issue Mar 20, 2024
@philwebb
Migrate gradle-pluigin to Antora
18a2b2e 
See gh-33766
philwebb added a commit that referenced this issue Mar 20, 2024
@philwebb
Migrate maven-plugin to Antora
8ee20c8 
See gh-33766
philwebb added a commit that referenced this issue Mar 20, 2024
@philwebb
Migrate spring-boot-docs to Antora
8dd89c1 
See gh-33766
philwebb added a commit that referenced this issue Mar 20, 2024
@philwebb
Attempt to fix Windows build error
0c0fa1b 
See gh-33766
philwebb added a commit to philwebb/spring-boot that referenced this issue Mar 20, 2024
@philwebb
Attempt to fix Windows build error
1240669 
See spring-projectsgh-33766
philwebb added a commit that referenced this issue Mar 21, 2024
@philwebb
Upgrade antora-zip-contents-collector-extension to 1.0.0-alpha.3
605930f 
See gh-33766
@wilkinsona wilkinsona modified the milestones: 3.3.x, 3.3.0-M3 Mar 21, 2024
wilkinsona added a commit that referenced this issue Mar 21, 2024
@wilkinsona
Reinstate Gradle Plugin toolchain's maximum compatible Java version
93fc2a4 
See gh-33766
philwebb added a commit that referenced this issue Mar 21, 2024
@philwebb
Attempt to fix Windows build error with Antora
75012c5 
See gh-33766
philwebb added a commit that referenced this issue Mar 23, 2024
@philwebb
Set version to true in antora.yml to allow docs generation
7e63c84 
See gh-33766
philwebb added a commit that referenced this issue Mar 25, 2024
@philwebb
Set version to true in antora.yml to allow docs generation
6bb6a79 
See gh-33766
@scottfrederick scottfrederick mentioned this issue Apr 3, 2024
Closed
@scottfrederick scottfrederick mentioned this issue Apr 24, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: documentation A documentation update
Projects
Spring Security Team
Status: No status
Milestone
3.3.0-M3
Development

No branches or pull requests
4 participants
@rwinch @philwebb @wilkinsona @spring-projects-issues