Repository navigation
Move the documentation from MkDocs to AsciiDoc, published on smallrye.io - #2732
Open
phillip-kruger wants to merge 4 commits into
Open
phillip-kruger wants to merge 4 commits into
phillip-kruger wants to merge 4 commits into
Conversation
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-graphql/<version>/. - One .adoc page per former .md page, same names except server_configuration and client_configuration, now server-configuration and client-configuration. - The sidebar is _nav.yml; shared attributes are in _attributes.adoc. - Code examples move from docs/snippets to docs/src/main/java, the module's standard source directory, and are included with include::{examples-dir}/...[]; they still compile with the build, so the build-helper plugin is no longer needed. - Pull requests touching docs/ are rendered with the smallrye.io site by the new Documentation workflow. - mkdocs.yml, the mike publishing workflow and its script are removed.
version-root lets pages in subdirectories use the same paths, partialsdir is where pages included by other pages go, and javadoc-version is set by smallrye.io for each release.
Member
Author
|
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:
|
||||||||||||||||||
The documentation the way smallrye.io shows it, published again when a page or an included example changes: ./mvnw -Pdocs-preview runs the smallrye.io docs tools with JBang (only Java needed), instead of a smallrye.github.io checkout and Python.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.






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).