Skip to content

Migrate TCK userguide from jbake to asciidoc - #420

Merged
mswatosh merged 5 commits into
jakartaee:mainfrom
mswatosh:jbake2asciidoc
Sep 17, 2026
Merged

mswatosh merged 5 commits into
jakartaee:mainfrom
mswatosh:jbake2asciidoc

Conversation

@mswatosh

@mswatosh mswatosh commented Aug 5, 2026 •

Copy link
Copy Markdown
Member

The JBake plugin in use was old enough that it didn't support ARM based Macbooks. Updating the plugin caused other issues, so I decided to move from jbake to asciidoc, which is already in use in this repository for other documents, and is used extensively for other Jakarta Specification documents. This simplifies and speeds up the TCK build process, and should make maintenance of the userguide easier.

This PR covers:

  • Migrating the Userguide form JBake to AsciiDoc
  • Adds filtering for the index and release notes html files. This allows variable substitution, so the links in the tck docs work when built as either a SNAPSHOT or final release.
  • Modernizes index.html to html5

Here's the docs folder of the tck since that's the easiest way to see the end result: docs.zip
Updated from Kyle's suggestions: docs.zip

@mswatosh mswatosh added this to the 2.2 milestone Aug 6, 2026
@mswatosh

Copy link
Copy Markdown
Member Author

@m0mus Would you be able to review this?

@KyleAure KyleAure left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for taking this on. Just some minor comments.

Comment thread tck/tck-docs/JSONP2.1-ReleaseNotes.html
Comment thread tck/tck-docs/userguide/src/main/resources/index.html Outdated
Comment thread tck/tck-docs/assertions/JSONP2.1JavadocAssertions.html
Assisted-by: IBM Bob 2.1.0
@mswatosh

Copy link
Copy Markdown
Member Author

I updated the JavadocAssertions to md, and merged the release notes and index.html into a single ReadMe.md. I also moved the pom.xml to the root of the folder and moved the ReadMe and JavadocAssertions so they're in the correct relative positions in the filesystem and final zip folder.

m0mus
m0mus previously approved these changes Sep 16, 2026
@mswatosh
mswatosh merged commit 468cc97 into jakartaee:main Sep 17, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants