Repository navigation
Move the documentation from MkDocs to AsciiDoc, published on smallrye.io - #2732
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.
|
||||||||||||||||||||||||||||||||||||
8d8c7b9 to
6f3fe84
Compare
6f3fe84 to
cc51144
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-graphql// (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
docs/*.mdbecomedocs/src/main/asciidoc/*.adocwith the same names. The exceptions areserver_configurationandclient_configuration, which becomeserver-configurationandclient-configuration._nav.ymland shared attributes are in_attributes.adoc.#name-mapping-aliases.docs/snippetstodocs/src/main/java, the module's standard source directory, so the build-helper plugin goes. They still compile with the build, and pages include them withinclude::{examples-dir}/...[].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.mkdocs.yml, the mike Publish the website workflow, and.github/render-documentation.sh. 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 point to the new location.Older versions
Everything already on
gh-pages(3.0.0.Beta8 and earlier) stays 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-graphql/latest/.Checked
mvn -pl docs -am install).