This is an automated email from the ASF dual-hosted git repository.
clebertsuconic pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/artemis.git
The following commit(s) were added to refs/heads/main by this push:
new 6d14145b5e ARTEMIS-5938 Reorganize chapter ordering
6d14145b5e is described below
commit 6d14145b5eab85b5e7fb130e69e16929c966a14d
Author: Clebert Suconic <[email protected]>
AuthorDate: Wed Mar 4 11:20:06 2026 -0500
ARTEMIS-5938 Reorganize chapter ordering
---
docs/user-manual/_book.adoc | 16 +++++++++-------
docs/user-manual/index.adoc | 16 +++++++++-------
docs/user-manual/lock-coordination.adoc | 2 +-
docs/user-manual/upgrading.adoc | 9 +++++++--
docs/user-manual/versions.adoc | 2 +-
5 files changed, 27 insertions(+), 18 deletions(-)
diff --git a/docs/user-manual/_book.adoc b/docs/user-manual/_book.adoc
index 523ca09932..9ad4cc3f58 100644
--- a/docs/user-manual/_book.adoc
+++ b/docs/user-manual/_book.adoc
@@ -11,6 +11,11 @@ image::images/artemis_text_black_small.png[align="center"]
include::project-info.adoc[leveloffset=1]
include::preface.adoc[leveloffset=1]
+
+//== Upgrading
+include::upgrading.adoc[leveloffset=1]
+
+//== Concepts
include::messaging-concepts.adoc[leveloffset=1]
include::architecture.adoc[leveloffset=1]
@@ -28,13 +33,7 @@ include::using-jms.adoc[leveloffset=1]
include::pre-acknowledge.adoc[leveloffset=1]
include::proxy-protocol.adoc[leveloffset=1]
-//== Upgrading
-
-include::versions.adoc[leveloffset=1]
-include::upgrading.adoc[leveloffset=1]
-
//== Getting Started
-
include::docker.adoc[leveloffset=1]
include::using-server.adoc[leveloffset=1]
include::using-cli.adoc[leveloffset=1]
@@ -60,6 +59,7 @@ include::metrics.adoc[leveloffset=1]
include::core-bridges.adoc[leveloffset=1]
include::clusters.adoc[leveloffset=1]
+include::lock-coordination.adoc[leveloffset=1]
include::ha.adoc[leveloffset=1]
include::network-isolation.adoc[leveloffset=1]
include::restart-sequence.adoc[leveloffset=1]
@@ -68,7 +68,6 @@ include::amqp-broker-connections.adoc[leveloffset=1]
include::amqp-address-federation.adoc[leveloffset=2]
include::amqp-queue-federation.adoc[leveloffset=2]
include::amqp-federation-configuration-glossary.adoc[leveloffset=2]
-include::lock-coordination.adoc[leveloffset=1]
include::federation.adoc[leveloffset=1]
include::federation-address.adoc[leveloffset=1]
include::federation-queue.adoc[leveloffset=1]
@@ -140,4 +139,7 @@ include::unit-testing.adoc[leveloffset=1]
include::resource-adapter.adoc[leveloffset=1]
include::configuration-index.adoc[leveloffset=1]
include::examples.adoc[leveloffset=1]
+
+//== Addendum
+include::versions.adoc[leveloffset=1]
include::notice.adoc[leveloffset=1]
diff --git a/docs/user-manual/index.adoc b/docs/user-manual/index.adoc
index 84c391487b..8013802b4b 100644
--- a/docs/user-manual/index.adoc
+++ b/docs/user-manual/index.adoc
@@ -12,9 +12,13 @@ image::images/artemis_text_black_small.png[align="center"]
*An in-depth manual on all aspects of {project-name-full} {project-version}*
== Overview
-
* xref:project-info.adoc#general-project-information[General Project
Information]
* xref:preface.adoc#why-use-{project-name-full-url}[Why use
{project-name-full}?]
+
+== Upgrading
+* xref:upgrading.adoc#upgrading-the-broker[Basic Upgrade Instructions]
+
+== Concepts
* xref:messaging-concepts.adoc#messaging-concepts[Messaging Concepts]
* xref:architecture.adoc#core-architecture[Core Architecture]
@@ -32,11 +36,6 @@ image::images/artemis_text_black_small.png[align="center"]
** xref:pre-acknowledge.adoc#extra-acknowledge-modes[Extra Acknowledge Modes]
* xref:proxy-protocol.adoc#proxy-protocol[PROXY Protocol]
-== Upgrading
-
-* xref:versions.adoc#versions[Version History]
-* xref:upgrading.adoc#upgrading-the-broker[Basic Upgrade Instructions]
-
== Getting Started
* xref:docker.adoc#docker[Docker]
@@ -64,7 +63,7 @@ image::images/artemis_text_black_small.png[align="center"]
* xref:core-bridges.adoc#core-bridges[Core Bridges]
* xref:clusters.adoc#clusters[Clustering]
-* xref:lock-coordination.adoc#lock-coordination[High Availability with
Mirroring]
+* xref:lock-coordination.adoc#lock-coordination[Lock Coordination / HA with
Mirroring]
* 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]
@@ -149,4 +148,7 @@ image::images/artemis_text_black_small.png[align="center"]
* xref:resource-adapter.adoc#jca-resource-adapter[JCA Resource Adapter]
* xref:configuration-index.adoc#configuration-reference[Configuration Index]
* xref:examples.adoc#examples[Examples]
+
+== Addendum
+* xref:versions.adoc#version-history[Version History]
* xref:notice.adoc#legal-notice[Legal Notice]
diff --git a/docs/user-manual/lock-coordination.adoc
b/docs/user-manual/lock-coordination.adoc
index 64ebaeda4d..92c8679876 100644
--- a/docs/user-manual/lock-coordination.adoc
+++ b/docs/user-manual/lock-coordination.adoc
@@ -1,4 +1,4 @@
-= Lock Coordination
+= Lock Coordination / HA with Mirroring
:idprefix:
:idseparator: -
:docinfo: shared
diff --git a/docs/user-manual/upgrading.adoc b/docs/user-manual/upgrading.adoc
index 52adf557a9..aacbd1dbfe 100644
--- a/docs/user-manual/upgrading.adoc
+++ b/docs/user-manual/upgrading.adoc
@@ -17,7 +17,12 @@ It also simplifies updating to newer versions.
== General Upgrade Procedure
-Upgrading may require some specific steps noted in the
xref:versions.adoc#versions[versions], but the general process is as follows:
+[IMPORTANT]
+====
+Review the xref:versions.adoc#version-history[version] history for specific
steps required for your upgrade before proceeding.
+====
+
+In general, the process is as follows:
. Navigate to the `etc` folder of the broker instance that's being upgraded
. Open `artemis.profile` and `artemis-utility.profile` (`artemis.profile.cmd`
and `artemis-utility.profile.cmd` on Windows).
@@ -39,7 +44,7 @@ It contains a property which is relevant for the upgrade:
The `ARTEMIS_HOME` property is used to link the instance with the home.
_In most cases_ the instance can be upgraded to a newer version simply by
changing the value of this property to the location of the new broker home.
-Please refer to the aforementioned xref:versions.adoc#versions[versions]
document for additional upgrade steps (if required).
+Please refer to the aforementioned
xref:versions.adoc#version-history[versions] document for additional upgrade
steps (if required).
It is also possible to do many of these update steps automatically, as can be
seen in the next section.
diff --git a/docs/user-manual/versions.adoc b/docs/user-manual/versions.adoc
index 17e1eb0e92..67c7549d73 100644
--- a/docs/user-manual/versions.adoc
+++ b/docs/user-manual/versions.adoc
@@ -1,4 +1,4 @@
-= Versions
+= Version History
:idprefix:
:idseparator: -
:docinfo: shared
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
