Skip to content

Commit b3d97de

Browse files
committed
ARTEMIS-5807: more doc updates around new TLP
1 parent 2df59c5 commit b3d97de

15 files changed

+144
-159
lines changed

docs/hacking-guide/_building.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,6 @@ The output for every module will be aggregated in `./target/dependency-check-rep
8686

8787
== Snapshot Builds
8888

89-
Snapshot builds are available at https://repository.apache.org/content/repositories/snapshots/org/apache/activemq/apache-artemis/.
89+
Snapshot builds are available at https://repository.apache.org/content/repositories/snapshots/org/apache/artemis/apache-artemis/.
9090

91-
These are built by https://ci-builds.apache.org/job/ActiveMQ/job/ActiveMQ-Artemis-SNAPSHOT-Deploy/[this Apache CI job].
91+
These are built by https://ci-builds.apache.org/job/Artemis/job/Artemis-SNAPSHOT-Deploy/[this Apache CI job].

docs/hacking-guide/_code.adoc

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -43,22 +43,18 @@ For example:
4343
+
4444
[,sh]
4545
----
46-
$ mvn -Pdev install
46+
$ mvn -Pdev install -DskipTests
4747
...
4848
[INFO] ------------------------------------------------------------------------
49-
[INFO] Reactor Summary:
49+
[INFO] Reactor Summary for Apache Artemis <VERSION>-SNAPSHOT:
5050
[INFO]
51-
[INFO] ActiveMQ Artemis Parent ........................... SUCCESS [2.298s]
52-
[INFO] ActiveMQ Artemis Commons .......................... SUCCESS [1.821s]
53-
[INFO] ActiveMQ Artemis Selector Implementation .......... SUCCESS [0.767s]
54-
[INFO] ActiveMQ Artemis Native POM ....................... SUCCESS [0.189s]
55-
[INFO] ActiveMQ Artemis Journal .......................... SUCCESS [0.646s]
56-
[INFO] ActiveMQ Artemis Core Client ...................... SUCCESS [5.969s]
57-
[INFO] ActiveMQ Artemis JMS Client ....................... SUCCESS [2.110s]
58-
[INFO] ActiveMQ Artemis Server ........................... SUCCESS [11.540s]
59-
...
60-
[INFO] ActiveMQ Artemis stress Tests ..................... SUCCESS [0.332s]
61-
[INFO] ActiveMQ Artemis performance Tests ................ SUCCESS [0.174s]
51+
[INFO] Apache Artemis ..................................... SUCCESS [ 2.435 s]
52+
[INFO] Apache Artemis Bill of Materials ................... SUCCESS [ 0.094 s]
53+
...etc...
54+
[INFO] Apache Artemis Server .............................. SUCCESS [ 11.866 s]
55+
...etc...
56+
[INFO] Apache Artemis JMS Client .......................... SUCCESS [ 1.036 s]
57+
...etc...
6258
[INFO] ------------------------------------------------------------------------
6359
[INFO] BUILD SUCCESS
6460
[INFO] ------------------------------------------------------------------------
@@ -139,7 +135,7 @@ Therefore you'll want to make sure that you either work in a branch that you do
139135

140136
. Get your changes merged into upstream
141137
.. Send a GitHub pull request, by clicking the pull request link while in your repo's fork.
142-
.. An email will automatically be sent to the ActiveMQ developer list.
138+
.. An email will automatically be sent to the Artemis issues mailing list.
143139
.. As part of the review you may see an automated test run comment on your request.
144140
.. After review a maintainer will merge your PR into the canonical git repository at which point those changes will be synced with the GitHub mirror repository (i.e. your `main`) and your PR will be closed by the `asfgit` bot.
145141

docs/hacking-guide/_validating-releases.adoc

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ When a release is proposed a maven repository is staged.
66

77
This information was extracted from https://maven.apache.org/guides/development/guide-testing-releases.html[Guide to Testing Staged Releases]
88

9-
For examples, the 1.1.0 release had the Maven Repository staged as https://repository.apache.org/content/repositories/orgapacheactivemq-1066.
9+
An example staging repository created during the release process would be: https://repository.apache.org/content/repositories/orgapacheartemis-1002.
1010

11-
The first thing you need to do is to be able to use this release.
12-
The easiest way we have found is to change your maven settings at `~/.m2/settings.xml`, setting up the staged repo.
11+
The first thing you need to do is to be able to access this staging repository.
12+
The easiest way we have found is to change your maven settings at `~/.m2/settings.xml`, setting up the staging repo.
1313

1414
[,xml]
1515
.~/.m2/settings.xml
@@ -18,49 +18,42 @@ The easiest way we have found is to change your maven settings at `~/.m2/setting
1818
<settings>
1919
<profiles>
2020
<profile>
21-
<id>activemq-artemis-test</id>
21+
<id>apache-artemis-staging</id>
2222
<repositories>
2323
<repository>
24-
<id>artemis-test</id>
25-
<name>ActiveMQ Artemis Test</name>
26-
<url>https://repository.apache.org/content/repositories/orgapacheactivemq-1066</url>
24+
<id>artemis-staging</id>
25+
<name>Apache Artemis Staging</name>
26+
<url>https://repository.apache.org/content/repositories/orgapacheartemis-1002</url>
2727
<layout>default</layout>
2828
<releases>
2929
<enabled>true</enabled>
3030
</releases>
3131
<snapshots>
32-
<enabled>true</enabled>
32+
<enabled>false</enabled>
3333
</snapshots>
3434
</repository>
3535
</repositories>
3636
3737
<pluginRepositories>
3838
<pluginRepository>
39-
<id>artemis-test2</id>
40-
<name>ActiveMQ Artemis Test</name>
41-
<url>https://repository.apache.org/content/repositories/orgapacheactivemq-1066</url>
39+
<id>artemis-staging</id>
40+
<name>Apache Artemis Staging</name>
41+
<url>https://repository.apache.org/content/repositories/orgapacheartemis-1002</url>
4242
<releases>
4343
<enabled>true</enabled>
4444
</releases>
4545
<snapshots>
46-
<enabled>true</enabled>
46+
<enabled>false</enabled>
4747
</snapshots>
4848
</pluginRepository>
4949
</pluginRepositories>
5050
</profile>
5151
</profiles>
5252
5353
<activeProfiles>
54-
<activeProfile>activemq-artemis-test</activeProfile>
54+
<activeProfile>apache-artemis-staging</activeProfile>
5555
</activeProfiles>
5656
</settings>
5757
----
5858

59-
After you configure this, all the maven objects will be available to your builds.
60-
61-
== Using the examples
62-
63-
The examples will create servers and use most of the maven components as real application were supposed to do.
64-
You can do this by running these examples after the `.m2` profile installations for the staged repository.
65-
66-
Of course, you can use your own applications after you have staged the maven repository.
59+
After you configure this, the maven artifacts for the release candidate will be available to your builds.

docs/user-manual/configuring-transports.adoc

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -303,30 +303,30 @@ When used on an `acceptor` this is the path to the SSL key store on the server w
303303
When used on a `connector` this is the path to the client-side SSL key store which holds the client certificates.
304304
This is only relevant for a `connector` if you are using 2-way SSL (i.e. mutual authentication).
305305
Although this value is configured on the server, it is downloaded and used by the client.
306-
If the client needs to use a different path from that set on the server then it can override the server-side setting by either using the customary "javax.net.ssl.keyStore" system property or the ActiveMQ-specific "org.apache.activemq.ssl.keyStore" system property.
307-
The ActiveMQ-specific system property is useful if another component on the client is already making use of the standard Java system property.
306+
If the client needs to use a different path from that set on the server then it can override the server-side setting by either using the customary "javax.net.ssl.keyStore" system property or the Artemis-specific "org.apache.activemq.ssl.keyStore" system property.
307+
The Artemis-specific system property is useful if another component on the client is already making use of the standard Java system property.
308308

309309
keyStorePassword::
310310
When used on an `acceptor` this is the password for the server-side keystore.
311311
+
312312
When used on a `connector` this is the password for the client-side keystore.
313313
This is only relevant for a `connector` if you are using 2-way SSL (i.e. mutual authentication).
314314
Although this value can be configured on the server, it is downloaded and used by the client.
315-
If the client needs to use a different password from that set on the server then it can override the server-side setting by either using the customary "javax.net.ssl.keyStorePassword" system property or the ActiveMQ-specific "org.apache.activemq.ssl.keyStorePassword" system property.
316-
The ActiveMQ-specific system property is useful if another component on the client is already making use of the standard Java system property.
315+
If the client needs to use a different password from that set on the server then it can override the server-side setting by either using the customary "javax.net.ssl.keyStorePassword" system property or the Artemis-specific "org.apache.activemq.ssl.keyStorePassword" system property.
316+
The Artemis-specific system property is useful if another component on the client is already making use of the standard Java system property.
317317

318318
keyStoreType::
319319
The type of keystore being used.
320320
For example, `JKS`, `JCEKS`, `PKCS12`, `PEM` etc.
321-
This value can also be set via the "javax.net.ssl.keyStoreType" system property or the ActiveMQ-specific "org.apache.activemq.ssl.keyStoreType" system property.
322-
The ActiveMQ-specific system property is useful if another component on the client is already making use of the standard Java system property.
321+
This value can also be set via the "javax.net.ssl.keyStoreType" system property or the Artemis-specific "org.apache.activemq.ssl.keyStoreType" system property.
322+
The Artemis-specific system property is useful if another component on the client is already making use of the standard Java system property.
323323
Default is `JKS`.
324324

325325
keyStoreProvider::
326326
The provider used for the keystore.
327327
For example, `SUN`, `SunJCE`, etc.
328-
This value can also be set via the "javax.net.ssl.keyStoreProvider" system property or the ActiveMQ-specific "org.apache.activemq.ssl.keyStoreProvider" system property.
329-
The ActiveMQ-specific system property is useful if another component on the client is already making use of the standard Java system property.
328+
This value can also be set via the "javax.net.ssl.keyStoreProvider" system property or the Artemis-specific "org.apache.activemq.ssl.keyStoreProvider" system property.
329+
The Artemis-specific system property is useful if another component on the client is already making use of the standard Java system property.
330330
Default is `null`.
331331

332332
keyStoreAlias::
@@ -343,30 +343,30 @@ This is only relevant for an `acceptor` if you are using 2-way SSL (i.e. mutual
343343
+
344344
When used on a `connector` this is the path to the client-side SSL key store which holds the public keys of all the servers that the client trusts.
345345
Although this value can be configured on the server, it is downloaded and used by the client.
346-
If the client needs to use a different path from that set on the server then it can override the server-side setting by either using the customary "javax.net.ssl.trustStore" system property or the ActiveMQ-specific "org.apache.activemq.ssl.trustStore" system property.
347-
The ActiveMQ-specific system property is useful if another component on the client is already making use of the standard Java system property.
346+
If the client needs to use a different path from that set on the server then it can override the server-side setting by either using the customary "javax.net.ssl.trustStore" system property or the Artemis-specific "org.apache.activemq.ssl.trustStore" system property.
347+
The Artemis-specific system property is useful if another component on the client is already making use of the standard Java system property.
348348

349349
trustStorePassword::
350350
When used on an `acceptor` this is the password for the server-side trust store.
351351
This is only relevant for an `acceptor` if you are using 2-way SSL (i.e. mutual authentication).
352352
+
353353
When used on a `connector` this is the password for the client-side truststore.
354354
Although this value can be configured on the server, it is downloaded and used by the client.
355-
If the client needs to use a different password from that set on the server then it can override the server-side setting by either using the customary "javax.net.ssl.trustStorePassword" system property or the ActiveMQ-specific "org.apache.activemq.ssl.trustStorePassword" system property.
356-
The ActiveMQ-specific system property is useful if another component on the client is already making use of the standard Java system property.
355+
If the client needs to use a different password from that set on the server then it can override the server-side setting by either using the customary "javax.net.ssl.trustStorePassword" system property or the Artemis-specific "org.apache.activemq.ssl.trustStorePassword" system property.
356+
The Artemis-specific system property is useful if another component on the client is already making use of the standard Java system property.
357357

358358
trustStoreType::
359359
The type of truststore being used.
360360
For example, `JKS`, `JCEKS`, `PKCS12`, `PEM` etc.
361-
This value can also be set via the "javax.net.ssl.trustStoreType" system property or the ActiveMQ-specific "org.apache.activemq.ssl.trustStoreType" system property.
362-
The ActiveMQ-specific system property is useful if another component on the client is already making use of the standard Java system property.
361+
This value can also be set via the "javax.net.ssl.trustStoreType" system property or the Artemis-specific "org.apache.activemq.ssl.trustStoreType" system property.
362+
The Artemis-specific system property is useful if another component on the client is already making use of the standard Java system property.
363363
Default is `JKS`.
364364

365365
trustStoreProvider::
366366
The provider used for the truststore.
367367
For example, `SUN`, `SunJCE`, etc.
368-
This value can also be set via the "javax.net.ssl.trustStoreProvider" system property or the ActiveMQ-specific "org.apache.activemq.ssl.trustStoreProvider" system property.
369-
The ActiveMQ-specific system property is useful if another component on the client is already making use of the standard Java system property.
368+
This value can also be set via the "javax.net.ssl.trustStoreProvider" system property or the Artemis-specific "org.apache.activemq.ssl.trustStoreProvider" system property.
369+
The Artemis-specific system property is useful if another component on the client is already making use of the standard Java system property.
370370
Default is `null`.
371371

372372
enabledCipherSuites::
@@ -412,7 +412,7 @@ Valid values are `true` or `false`.
412412
Default is `false`.
413413

414414
forceSSLParameters::
415-
When used on a `connector` any SSL settings that are set as parameters on the connector will be used instead of JVM system properties including both javax.net.ssl and ActiveMQ system properties to configure the SSL context for this connector.
415+
When used on a `connector` any SSL settings that are set as parameters on the connector will be used instead of JVM system properties including both javax.net.ssl and Artemis system properties to configure the SSL context for this connector.
416416
+
417417
Valid values are `true` or `false`.
418418
Default is `false`.

docs/user-manual/docker.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ In order to build an image you need a binary distribution.
4949
This can be sourced *locally* (in which case you need to build the project first) or *remotely* based on an official Apache release.
5050

5151
=== Using a Local Release
52-
If you want to use a local binary distribution then build it from the root of the ActiveMQ source tree, e.g.:
52+
If you want to use a local binary distribution then build it from the root of the Artemis source tree, e.g.:
5353
[,console]
5454
----
5555
$ mvn -Prelease package -DskipTests

0 commit comments

Comments
 (0)