Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor Asciidoc documentation and remove Markdown #78

Merged
merged 11 commits into from
Nov 10, 2021

Conversation

patrick-stephens
Copy link
Contributor

Switching now to all user documentation must be in Asciidoc. Dev documentation still in Markdown as not part of the CMOS generation.

Refactored current auto-generated documentation to split it up into more appropriate pages - still some work to do for duplication and updates of examples/config.
Image links work in the generated HTML, Github rendering seems to not support an Antora folder structure, e.g. asciidoctor/asciidoctor-vscode#230

Landing page for repo is simplified now just to reference to the Asciidoc pages.

docs/modules/ROOT/pages/cluster-monitor.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/deployment-onpremise.adoc Outdated Show resolved Hide resolved
@patrick-stephens patrick-stephens merged commit 5de8091 into main Nov 10, 2021
@patrick-stephens patrick-stephens deleted the refactor_docs branch November 10, 2021 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants