mirror of
https://github.com/apache/activemq-artemis.git
synced 2025-02-07 02:29:08 +00:00
3a4b421d2e
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
25 lines
1.4 KiB
Plaintext
25 lines
1.4 KiB
Plaintext
= Why use Apache ActiveMQ Artemis?
|
|
:idprefix:
|
|
:idseparator: -
|
|
|
|
Here are just a few reasons:
|
|
|
|
* 100% open source software.
|
|
Apache ActiveMQ Artemis is licensed using the Apache Software License v 2.0 to minimise barriers to adoption.
|
|
* Apache ActiveMQ Artemis is designed with usability in mind.
|
|
* Written in Java.
|
|
Runs on any platform with a Java 11+ runtime, that's everything from Windows desktops to IBM mainframes.
|
|
* Amazing performance.
|
|
Our ground-breaking high performance journal provides persistent messaging performance at rates normally seen for non-persistent messaging, our non-persistent messaging performance rocks the boat too.
|
|
* Full feature set.
|
|
All the features you'd expect in any serious messaging system, and others you won't find anywhere else.
|
|
* Elegant, clean-cut design with minimal third party dependencies.
|
|
Run ActiveMQ Artemis stand-alone, run it in integrated in your favourite Java EE application server, or run it embedded inside your own product.
|
|
It's up to you.
|
|
* Seamless high availability.
|
|
We provide a HA solution with automatic client failover so you can guarantee zero message loss or duplication in event of server failure.
|
|
* Hugely flexible clustering.
|
|
Create clusters of servers that know how to load balance messages.
|
|
Link geographically distributed clusters over unreliable connections to form a global network.
|
|
Configure routing of messages in a highly flexible way.
|