ARTEMIS-4383 migrate user docs to AsciiDoc
Markdown, which is currently used for user-facing documentation, is good
for a lot of things. However, it's not great for the kind of complex
documentation we have and our need to produce both multi-page HTML and
single-page PDF output via Maven.
Markdown lacks features which would make the documentation easier to
read, easier to navigate, and just look better overall.
The current tool-chain uses honkit and a tool called Calibre. Honkit is
written in TypeScript and is installed via NPM. Calibre is a native tool
so it must be installed via an OS-specific package manager. All this
complexity makes building, releasing, uploading, etc. a pain.
AsciiDoc is relatively simple like Markdown, but it has more features
for presentation and navigation not to mention Java-based Maven tooling
to generate both HTML and PDF. Migrating will improve both the
appearance of the documentation as well as the processes to generate and
upload it.
This commit contains the following changes:
- Convert all the Markdown for the User Manual, Migration Guide, and
Hacking guide to AsciiDoc via kramdown [1].
- Update the `artemis-website` build to use AsciiDoctor Maven tooling.
- Update `RELEASING.md` with simplified instructions.
- Update Hacking Guide with simplified instructions.
- Use AsciiDoc link syntax in Artemis Maven doc plugin.
- Drop EPUB & MOBI docs for User Manual as well as PDF for the Hacking
Guide. All docs will be HTML only except for the User Manual which
will have PDF.
- Move all docs up out of their respective "en" directory. This was a
hold-over from when we had docs in different languages.
- Migration & Hacking Guides are now single-page HTML since they are
relatively short.
- Refactor README.md to simplify and remove redundant content.
Benefits of the change:
- Much simplified tooling. No more NPM packages or native tools.
- Auto-generated table of contents for every chapter.
- Auto-generated anchor links for every sub-section.
- Overall more appealing presentation.
- All docs will use the ActiveMQ favicon.
- No more manual line-wrapping! AsciiDoc recommends one sentence per
line and paragraphs are separated by a blank line.
- AsciiDoctor plugins for IDEA are quite good.
- Resulting HTML is less than *half* of the previous size.
All previous links/bookmarks should continue to work.
[1] https://github.com/asciidoctor/kramdown-asciidoc
2023-07-27 22:45:17 -05:00
|
|
|
= Apache ActiveMQ Artemis Hacking Guide
|
|
|
|
|
|
|
|
|
|
This hacking guide outlines how developers can get involved in contributing to the Apache ActiveMQ Artemis project.
|
|
|
|
|
|
|
|
|
|
include::_code.adoc[leveloffset=1]
|
|
|
|
|
include::_ide.adoc[leveloffset=1]
|
|
|
|
|
include::_building.adoc[leveloffset=1]
|
|
|
|
|
include::_tests.adoc[leveloffset=1]
|
|
|
|
|
include::_code-coverage-report.adoc[leveloffset=1]
|
|
|
|
|
include::_formatting.adoc[leveloffset=1]
|
|
|
|
|
include::_validating-releases.adoc[leveloffset=1]
|
|
|
|
|
include::_maintainers.adoc[leveloffset=1]
|
|
|
|
|
include::_history.adoc[leveloffset=1]
|
|
|
|
|
include::_notice.adoc[leveloffset=1]
|