Repository navigation
Move the documentation from Antora to AsciiDoc pages published on smallrye.io - #733
phillip-kruger wants to merge 1 commit into
Conversation
|
Screenshots of the documentation before and after this change (updated). Before: the MkDocs 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.
|
||||||||||||||||||||||||||||
Ladicek
left a comment
There was a problem hiding this comment.
LGTM, but I'll wait with merging until smallrye/smallrye.github.io#136 is done, as advised there.
537bfa3 to
2197844
Compare










The docs move from their own Antora site to AsciiDoc laid out like the Quarkus guides. smallrye.io pulls them in and publishes them at https://smallrye.io/docs/jandex// (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/**becomedocs/src/main/asciidoc/**with the same paths, so the pages keep their names (core/indexing,maven/basic, …).nav.adocbecomes_nav.yml; shared attributes are in_attributes.adoc.:version-root:so shared paths work from any depth.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, playbooks), the Jandex GitHub Pages workflow, and the release job that ran it. The release no longer publishes docs; smallrye.io picks up the tag.docs/README.adocexplains how to write and preview pages, and the README links to the new location.Old addresses
The current site at https://smallrye.io/jandex/ (
gh-pages,docs/jandex/main/*.html) stays where it is for now. Its pages will separately be replaced by redirects to the same page under https://smallrye.io/docs/jandex/latest/.Checked