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 23:45:17 -04:00
|
|
|
////
|
|
|
|
|
This is the landing page for the multi-page HTML manual.
|
|
|
|
|
It *links* to all chapters following the same basic pattern as _book.adoc. These two documents should stay in sync.
|
|
|
|
|
////
|
|
|
|
|
:idprefix:
|
|
|
|
|
:idseparator: -
|
|
|
|
|
|
|
|
|
|
image::images/activemq-logo.png[align="center"]
|
|
|
|
|
|
|
|
|
|
[.text-center]
|
|
|
|
|
*An in-depth manual on all aspects of Apache ActiveMQ Artemis {project-version}*
|
|
|
|
|
|
|
|
|
|
== Overview
|
|
|
|
|
|
|
|
|
|
* xref:project-info.adoc#general-project-information[General Project Information]
|
|
|
|
|
* xref:preface.adoc#why-use-apache-activemq-artemis[Why use Apache ActiveMQ Artemis?]
|
|
|
|
|
* xref:messaging-concepts.adoc#messaging-concepts[Messaging Concepts]
|
|
|
|
|
* xref:architecture.adoc#core-architecture[Core Architecture]
|
|
|
|
|
|
|
|
|
|
== Protocols & APIs
|
|
|
|
|
|
|
|
|
|
* xref:protocols-interoperability.adoc#protocols-and-interoperability[Protocols and Interoperability]
|
|
|
|
|
* xref:amqp.adoc#amqp[AMQP]
|
|
|
|
|
* xref:stomp.adoc#stomp[STOMP]
|
|
|
|
|
* xref:mqtt.adoc#mqtt[MQTT]
|
|
|
|
|
* xref:openwire.adoc#openwire[OpenWire]
|
|
|
|
|
* xref:core.adoc#using-core[Using Core]
|
|
|
|
|
** xref:client-failover.adoc#core-client-failover[Core Client Failover]
|
|
|
|
|
* xref:jms-core-mapping.adoc#mapping-jms-concepts-to-the-core-api[Mapping JMS Concepts to the Core API]
|
|
|
|
|
* xref:using-jms.adoc#using-jms-or-jakarta-messaging[Using JMS or Jakarta Messaging]
|
|
|
|
|
** xref:pre-acknowledge.adoc#extra-acknowledge-modes[Extra Acknowledge Modes]
|
|
|
|
|
|
|
|
|
|
== Upgrading
|
|
|
|
|
|
|
|
|
|
* xref:versions.adoc#versions[Version History]
|
|
|
|
|
* xref:upgrading.adoc#upgrading-the-broker[Basic Upgrade Instructions]
|
|
|
|
|
|
|
|
|
|
== Getting Started
|
|
|
|
|
|
2023-09-21 17:40:34 -04:00
|
|
|
* xref:docker.adoc#docker[Docker]
|
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 23:45:17 -04:00
|
|
|
* xref:using-server.adoc#using-the-server[Using the Server]
|
|
|
|
|
* xref:using-cli.adoc#command-line-interface[Using the Command-Line Interface]
|
|
|
|
|
* xref:client-classpath.adoc#the-client-classpath[JMS & Jakarta Client Classpath]
|
|
|
|
|
|
|
|
|
|
== Addressing
|
|
|
|
|
|
|
|
|
|
* xref:address-model.adoc#address-model[Address Model]
|
|
|
|
|
* xref:address-settings.adoc#address-settings[Address Settings]
|
|
|
|
|
* xref:wildcard-syntax.adoc#wildcard-syntax[Wildcard Syntax]
|
|
|
|
|
* xref:wildcard-routing.adoc#routing-messages-with-wild-cards[Wildcard Routing]
|
|
|
|
|
* xref:diverts.adoc#diverting-and-splitting-message-flows[Splitting and Diverting Message Flow]
|
|
|
|
|
* xref:transformers.adoc#transformers[Transforming Messages]
|
|
|
|
|
* xref:filter-expressions.adoc#filter-expressions[Filter Expressions]
|
|
|
|
|
|
|
|
|
|
== Management and Monitoring
|
|
|
|
|
|
|
|
|
|
* xref:management.adoc#management[Management]
|
|
|
|
|
* xref:management-console.adoc#management-console[Web Management Console]
|
|
|
|
|
* xref:metrics.adoc#metrics[Metrics]
|
|
|
|
|
|
|
|
|
|
== Broker-to-Broker Connectivity
|
|
|
|
|
|
|
|
|
|
* xref:core-bridges.adoc#core-bridges[Core Bridges]
|
|
|
|
|
* xref:clusters.adoc#clusters[Clustering]
|
|
|
|
|
* xref:federation.adoc#federation[Federation]
|
|
|
|
|
** xref:federation-address.adoc#address-federation[Address Federation]
|
|
|
|
|
** xref:federation-queue.adoc#queue-federation[Queue Federation]
|
|
|
|
|
* xref:ha.adoc#high-availability-and-failover[High Availability & Failover]
|
|
|
|
|
** xref:network-isolation.adoc#network-isolation-split-brain[Network Isolation]
|
|
|
|
|
** xref:restart-sequence.adoc#restart-sequence[Restart Sequence]
|
|
|
|
|
** xref:activation-tools.adoc#activation-sequence-tools[Activation Tools]
|
|
|
|
|
* xref:connection-routers.adoc#connection-routers[Routing Connections]
|
|
|
|
|
* xref:amqp-broker-connections.adoc#broker-connections[Broker Connections]
|
|
|
|
|
* xref:jms-bridge.adoc#the-jms-bridge[JMS Bridge]
|
|
|
|
|
|
|
|
|
|
== Security
|
|
|
|
|
|
|
|
|
|
* xref:security.adoc#authentication-authorization[Authentication & Authorization]
|
|
|
|
|
* xref:masking-passwords.adoc#masking-passwords[Masking Passwords]
|
|
|
|
|
* xref:resource-limits.adoc#resource-limits[Limiting Resource Utilization]
|
|
|
|
|
|
|
|
|
|
== Performance
|
|
|
|
|
|
|
|
|
|
* xref:perf-tuning.adoc#performance-tuning[Tuning]
|
|
|
|
|
* xref:perf-tools.adoc#performance-tools[Tools]
|
|
|
|
|
* xref:thread-pooling.adoc#thread-management[Thread Management]
|
|
|
|
|
|
|
|
|
|
== Advanced Use-cases
|
|
|
|
|
|
|
|
|
|
* xref:scheduled-messages.adoc#scheduled-messages[Scheduled Messages]
|
|
|
|
|
* xref:last-value-queues.adoc#last-value-queues[Last-value Queues]
|
|
|
|
|
* xref:non-destructive-queues.adoc#non-destructive-queues[Non-destructive Queues]
|
|
|
|
|
* xref:ring-queues.adoc#ring-queue[Ring Queues]
|
|
|
|
|
* xref:retroactive-addresses.adoc#retroactive-addresses[Retroactive Addresses]
|
|
|
|
|
* xref:exclusive-queues.adoc#exclusive-queues[Exclusive Queues]
|
|
|
|
|
* xref:message-grouping.adoc#message-grouping[Message Grouping]
|
|
|
|
|
* xref:consumer-priority.adoc#consumer-priority[Consumer Priority]
|
|
|
|
|
* xref:message-expiry.adoc#message-expiry[Message Expiry]
|
|
|
|
|
* xref:large-messages.adoc#large-messages[Large Messages]
|
|
|
|
|
* xref:paging.adoc#paging[Paging]
|
|
|
|
|
* xref:duplicate-detection.adoc#duplicate-message-detection[Detecting Duplicate Messages]
|
|
|
|
|
* xref:undelivered-messages.adoc#message-redelivery-and-undelivered-messages[Message Redelivery and Undelivered Messages]
|
|
|
|
|
|
|
|
|
|
== Data & Disk
|
|
|
|
|
|
|
|
|
|
* xref:persistence.adoc#persistence[Persistence]
|
|
|
|
|
* xref:data-tools.adoc#data-tools[Data Tools]
|
|
|
|
|
* xref:libaio.adoc#libaio-native-libraries[Libaio Native Libraries]
|
|
|
|
|
|
|
|
|
|
== Network Connectivity & Configuration
|
|
|
|
|
|
|
|
|
|
* xref:connection-ttl.adoc#detecting-dead-connections[Detecting Dead Connections]
|
|
|
|
|
* xref:configuring-transports.adoc#configuring-the-transport[Configuring Network Transports]
|
|
|
|
|
* xref:flow-control.adoc#flow-control[Flow Control for Remote Core Clients]
|
|
|
|
|
|
|
|
|
|
== Customizing Broker Behavior
|
|
|
|
|
|
|
|
|
|
* xref:broker-plugins.adoc#plugin-support[Broker Plugins]
|
|
|
|
|
* xref:intercepting-operations.adoc#intercepting-operations[Intercepting Network Operations]
|
|
|
|
|
|
|
|
|
|
== Miscellaneous
|
|
|
|
|
|
|
|
|
|
* xref:config-reload.adoc#configuration-reload[Reloading Configuration]
|
|
|
|
|
* xref:slow-consumers.adoc#detecting-slow-consumers[Detecting Slow Consumers]
|
|
|
|
|
* xref:critical-analysis.adoc#critical-analysis-of-the-broker[Critical Analyzer]
|
|
|
|
|
* xref:transaction-config.adoc#resource-manager-configuration[JTA Resource Manager Configuration]
|
|
|
|
|
* xref:send-guarantees.adoc#guarantees-of-sends-and-commits[Guarantees of Sends and Commits]
|
|
|
|
|
* xref:graceful-shutdown.adoc#graceful-server-shutdown[Graceful Server Shutdown]
|
|
|
|
|
* xref:web-server.adoc#embedded-web-server[Configuring & Managing the Embedded Web Server]
|
|
|
|
|
* xref:logging.adoc#logging[Logging]
|
|
|
|
|
* xref:embedding-activemq.adoc#embedding-apache-activemq-artemis[Embedding Apache ActiveMQ Artemis]
|
|
|
|
|
* xref:karaf.adoc#artemis-on-apache-karaf[Apache Karaf Integration]
|
|
|
|
|
* xref:tomcat.adoc#apache-tomcat-support[Apache Tomcat Support]
|
|
|
|
|
* xref:cdi-integration.adoc#cdi-integration[CDI Integration]
|
|
|
|
|
* xref:copied-message-properties.adoc#properties-for-copied-messages[Properties for Copied Messages]
|
|
|
|
|
* xref:maven-plugin.adoc#maven-plugins[Maven Plugin]
|
|
|
|
|
* xref:unit-testing.adoc#unit-testing[Unit Testing]
|
|
|
|
|
* xref:resource-adapter.adoc#jca-resource-adapter[JCA Resource Adapter]
|
|
|
|
|
* xref:configuration-index.adoc#configuration-reference[Configuration Index]
|
|
|
|
|
* xref:examples.adoc#examples[Examples]
|
|
|
|
|
* xref:notice.adoc#legal-notice[Legal Notice]
|