Repository navigation
docs: move the documentation from MkDocs to AsciiDoc, published on smallrye.io - #2220
phillip-kruger wants to merge 1 commit into
Conversation
0941e85 to
5b1af9a
Compare
|
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.
|
||||||||||||||||||||||||||||||||||||||||
fa3c302 to
580c382
Compare
















The docs move from MkDocs to AsciiDoc, laid out like the Quarkus guides. smallrye.io pulls them in and publishes them at https://smallrye.io/docs/smallrye-mutiny// (smallrye/smallrye.github.io#136):
mainnightly, each release once it is tagged. smallrye.io already publishes 3.3.0's docs, converted on the fly, so nothing waits for this PR.Depends on smallrye/smallrye.github.io#136. The new Documentation check calls the reusable workflow added there.
What changes
documentation/docs/**/*.mdbecomedocumentation/src/main/asciidoc/**/*.adoc, with the same paths, so the same addresses._nav.ymland shared attributes are in_attributes.adoc._versions.adoc..build/UpdateDocsAttributesFiles.java, run byjust prepare-release, now writes it instead ofattributes.yaml.documentation/src/testand still compile and run (149 tests pass). Pages include them withinclude::{examples-dir}/...[tags=...], and the docissimo// <tag>markers become// tag::tag[]/// end::tag[]. Only comment lines change.:topics:, andtags-indexlists the pages per tag.documentation/run the new 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. It replaces the MkDocs check inbuild-pull.yml.mkdocs.yml, the macros, the uv/Python project, and the mike Manual website deployment workflow.documentation/README.adocexplains how to write and preview pages, and the README,math/README.mdand pom links point to the new location.Older versions
Everything already on
gh-pagesstays where it is, and the site's version picker links to it as "Older versions". After this is merged, the mikelatestalias and the root page ongh-pageswill redirect to/docs/smallrye-mutiny/latest/.Checked
mvn -pl documentation testpasses.