Repository navigation
Move the documentation from Antora to AsciiDoc pages published on smallrye.io - #935
Conversation
…llrye.io The docs are now AsciiDoc in docs/src/main/asciidoc, laid out like the Quarkus guides, and smallrye.io pulls them in: the main branch nightly and each release once tagged, at https://smallrye.io/docs/smallrye-jwt/<version>/. They are no longer built by Antora. - One .adoc page per former Antora page, same names; the sidebar is _nav.yml and shared attributes are in _attributes.adoc. - Section ids are Quarkus-style (like-this); old /docs/smallrye-jwt/... addresses on smallrye.io redirect to the new pages. - Pull requests touching docs/ are rendered with the smallrye.io site by the new Documentation workflow. - doc/ (antora.yml and the playbook) is removed.
|
Screenshots of the documentation before and after this change (updated). Before: the Antora site, as it is on smallrye.io today. After: this branch's AsciiDoc, rendered by smallrye.io with smallrye/smallrye.github.io#136 (a local build:
Dark theme: the same screenshots with the dark themeThe old Antora sites and the GraphQL, Vert.x bindings and Mutiny Zero MkDocs sites have no dark theme, so their "before" stays light; the other old MkDocs sites were switched to their own dark palette.
|
||||||||||||||||||||||||||||










The docs move from Antora to AsciiDoc, laid out like the Quarkus guides. smallrye.io pulls them in and publishes them at https://smallrye.io/docs/smallrye-jwt// (smallrye/smallrye.github.io#136):
mainnightly, each release once it is tagged.Depends on smallrye/smallrye.github.io#136. The new Documentation check calls the reusable workflow added there.
What changes
doc/modules/ROOT/pages/*.adocbecomedocs/src/main/asciidoc/*.adoc, with the same names (so the same addresses)._nav.yml(fromnav.adoc), and shared attributes are in_attributes.adoc.#a-section.:doctype: bookwith anattributes.adocinclude. They are now regular pages with one title each. The included file only set an unused:version: 2.1.2-SNAPSHOT, so it is gone. The cross-page<<generate-jwt-tokens>>reference is now anxref:.docs/run the Documentation workflow. It renders the docs with the smallrye.io site, fails on a broken include or a page that does not render, and attaches the rendered site as an artifact.doc/(antora.yml, the playbook).docs/README.adocexplains how to write and preview pages, and the README links point to the new location.Old addresses
smallrye.io already publishes this project's current release from the Antora sources, converted on the fly. The old
/docs/smallrye-jwt/...htmladdresses redirect to the new pages.Checked
All 3 pages render with the smallrye.io site, with no errors or Asciidoctor warnings, and all internal links resolve.