Skip to content

Commit 044de42

Browse files
committed
ARTEMIS-5807: update various docs titles, references, links, images
1 parent acf60a8 commit 044de42

File tree

13 files changed

+20
-19
lines changed

13 files changed

+20
-19
lines changed

artemis-website/pom.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,8 @@
9090
<goal>jar</goal>
9191
</goals>
9292
<configuration>
93-
<doctitle>ActiveMQ Artemis ${project.version} API</doctitle>
93+
<windowtitle>Apache Artemis ${project.version} API</windowtitle>
94+
<doctitle>Apache Artemis ${project.version} API</doctitle>
9495
<minmemory>128m</minmemory>
9596
<maxmemory>512m</maxmemory>
9697
<noindex>true</noindex>
@@ -381,9 +382,9 @@
381382

382383
<!-- Version substitution attributes -->
383384
<project-version>${project.version}</project-version>
384-
<project-name-full>Apache ActiveMQ Artemis</project-name-full>
385-
<project-name-full-url>apache-activemq-artemis</project-name-full-url>
386-
<project-name-short>ActiveMQ Artemis</project-name-short>
385+
<project-name-full>Apache Artemis</project-name-full>
386+
<project-name-full-url>apache-artemis</project-name-full-url>
387+
<project-name-short>Artemis</project-name-short>
387388
<log4j-version>${log4j.version}</log4j-version>
388389
</attributes>
389390
<logHandler>

docs/hacking-guide/_maintainers.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ However, the expectation here is that the developer has made a good effort to te
77

88
What does it mean to be reasonably confident?
99
If the developer has run the same maven commands that the pull-request builds are running they can be reasonably confident.
10-
Currently the https://builds.apache.org/job/ActiveMQ-Artemis-PR-Build/[PR build] runs this command:
10+
Currently the https://github.com/apache/artemis/blob/main/.github/workflows/build.yml[PR build] runs this command:
1111
[,console]
1212
----
13-
$ mvn -Pfast-tests install
13+
$ mvn -Pfast-tests -Pcompatibility-tests install
1414
----
1515
However, if the changes are significant, touches a wide area of code, or even if the developer just wants a second opinion they are encouraged to engage other members of the community to obtain an additional review prior to pushing.
1616
This can easily be done via a pull request on GitHub, a patch file attached to an email or JIRA, commit to a branch in the Apache git repo, etc.
@@ -36,7 +36,7 @@ This format follows the recommendation from the https://git-scm.com/book/en/v2/D
3636
Aside from the traditional `origin` and `upstream` repositories committers will need an additional reference for the canonical Apache git repository where they will be merging and pushing pull-requests.
3737
For the purposes of this document, let's assume these ref/repo associations already exist as described in the xref:code.adoc[Working with the Code] section:
3838

39-
* `origin` : https://github.com/(your-user-name)/activemq-artemis.git
39+
* `origin` : https://github.com/(your-user-name)/artemis.git
4040
* `upstream` : https://github.com/apache/artemis
4141

4242
. Add the canonical Apache repository as a remote.
@@ -54,7 +54,7 @@ Just be sure to edit all references to the remote repo name so it's consistent.
5454
[,console]
5555
----
5656
[remote "upstream"]
57-
url = [email protected]:apache/activemq-artemis.git
57+
url = [email protected]:apache/artemis.git
5858
fetch = +refs/heads/*:refs/remotes/upstream/*
5959
fetch = +refs/pull/*/head:refs/remotes/upstream/pr/*
6060
----
@@ -75,7 +75,7 @@ remote: Compressing objects: 100% (188/188), done.
7575
remote: Total 566 (delta 64), reused 17 (delta 17), pack-reused 351
7676
Receiving objects: 100% (566/566), 300.67 KiB | 0 bytes/s, done.
7777
Resolving deltas: 100% (78/78), done.
78-
From github.com:apache/activemq-artemis
78+
From github.com:apache/artemis
7979
* [new ref] refs/pull/105/head -> upstream/pr/105
8080
----
8181
. Checkout the pull request you wish to review
@@ -141,7 +141,7 @@ Example:
141141
[,console]
142142
----
143143
$ pwd
144-
/checkouts/apache-activemq-artemis
144+
/checkouts/artemis
145145
146146
$ ./scripts/merge-PR.sh 175 ARTEMIS-229 address on Security Interface
147147
----

docs/hacking-guide/_tests.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ A simple test like this takes less than a second to run on modern hardware.
3636

3737
Although `org.apache.activemq.artemis.tests.integration.SimpleTest` is simple it could be simpler still by extending https://github.com/apache/artemis/blob/main/artemis-server/src/test/java/org/apache/activemq/artemis/tests/util/SingleServerTestBase.java[`org.apache.activemq.artemis.tests.util.SingleServerTestBase`].
3838
This class does all the setup of a simple server automatically and provides the test-case with a `ServerLocator`, `ClientSessionFactory`, and `ClientSession` instance.
39-
https://github.com/apache/artemis/blob/main//tests/integration-tests/src/test/java/org/apache/activemq/artemis/tests/integration/SingleServerSimpleTest.java[`org.apache.activemq.artemis.tests.integration.SingleServerSimpleTest`] is an example based on `org.apache.activemq.artemis.tests.integration.SimpleTest` but extends `org.apache.activemq.artemis.tests.util.SingleServerTestBase` which eliminates all the setup and class variables which are provided by `SingleServerTestBase` itself.
39+
https://github.com/apache/artemis/blob/main/tests/integration-tests/src/test/java/org/apache/activemq/artemis/tests/integration/SingleServerSimpleTest.java[`org.apache.activemq.artemis.tests.integration.SingleServerSimpleTest`] is an example based on `org.apache.activemq.artemis.tests.integration.SimpleTest` but extends `org.apache.activemq.artemis.tests.util.SingleServerTestBase` which eliminates all the setup and class variables which are provided by `SingleServerTestBase` itself.
4040

4141
== Writing Web Tests
4242

@@ -102,4 +102,4 @@ In any case, `org.apache.activemq.artemis.core.config.Configuration` is a https:
102102
=== Look at other test-cases
103103

104104
If you need ideas on how to configure something or test something try looking through the test-suite at other test-cases which may be similar.
105-
This is one of the best ways to learn how the test-suite works and how you can leverage the testing infrastructure to test your particular case.
105+
This is one of the best ways to learn how the test-suite works and how you can leverage the testing infrastructure to test your particular case.
-21.7 KB
Loading
-21.7 KB
Loading

docs/user-manual/_book.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
This is used to generate the single-page PDF manual.
33
It *aggregates* all chapters into a single document following the same pattern as index.adoc. These two documents should stay in sync.
44
////
5-
image::images/activemq-logo.png[align="center"]
5+
image::images/artemis_text_black_small.png[align="center"]
66

77
[.text-center]
88
*An in-depth manual on all aspects of {project-name-full} {project-version}*
@@ -126,7 +126,7 @@ include::send-guarantees.adoc[leveloffset=1]
126126
include::graceful-shutdown.adoc[leveloffset=1]
127127
include::web-server.adoc[leveloffset=1]
128128
include::logging.adoc[leveloffset=1]
129-
include::embedding-activemq.adoc[leveloffset=1]
129+
include::embedding-artemis.adoc[leveloffset=1]
130130
include::karaf.adoc[leveloffset=1]
131131
include::tomcat.adoc[leveloffset=1]
132132
include::cdi-integration.adoc[leveloffset=1]

docs/user-manual/architecture.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ For more information on server configuration files see xref:configuration-index.
5353

5454
The broker is designed as a set of simple POJOs so if you have an application that requires messaging functionality internally, but you don't want to expose that as an independent, standalone broker, you can directly instantiate and embed a broker in your own application.
5555

56-
Read more about xref:embedding-activemq.adoc#embedding-{project-name-full-url}[embedding a broker].
56+
Read more about xref:embedding-artemis.adoc#embedding-{project-name-full-url}[embedding a broker].
5757

5858
== Integrated with a Java/Jakarta EE application server
5959

@@ -77,4 +77,4 @@ It is possible to talk to a JMS messaging system directly from an EJB, MDB or se
7777
Note that all communication between EJB sessions or entity beans and Message Driven beans go through the adaptor and not directly to the broker.
7878

7979
The large arrow with the prohibited sign shows an EJB session bean talking directly to the the broker.
80-
This is not recommended as you'll most likely end up creating a new connection and session every time you want to interact from the EJB, which is an anti-pattern.
80+
This is not recommended as you'll most likely end up creating a new connection and session every time you want to interact from the EJB, which is an anti-pattern.
-28.7 KB
Binary file not shown.
4.23 KB
Loading

0 commit comments

Comments
 (0)