You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@james.apache.org by bt...@apache.org on 2023/05/30 04:43:47 UTC
[james-project] 04/05: [RELEASE] Documentation changes for 3.8.0
This is an automated email from the ASF dual-hosted git repository.
btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git
commit bff6f3ad4bc360bf505b8ef82fef4c330f02b579
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Wed May 17 09:35:43 2023 +0700
[RELEASE] Documentation changes for 3.8.0
---
README.adoc | 2 +-
docs/antora.yml | 2 +-
server/apps/distributed-app/docs/antora.yml | 2 +-
.../docs/modules/ROOT/pages/operate/index.adoc | 26 ++++++++++++----------
.../docs/modules/ROOT/pages/run/k8s-values.adoc | 2 +-
.../docs/modules/ROOT/pages/run/run-docker.adoc | 4 ++--
.../distributed-app/helm-chart/james/values.yaml | 2 +-
src/homepage/index.html | 6 ++---
src/site/markdown/mailet/quickstart.md | 2 +-
src/site/xdoc/server/install.xml | 8 +++----
src/site/xdoc/server/packaging.xml | 16 ++++++-------
src/site/xdoc/server/release-notes.xml | 4 ++++
12 files changed, 41 insertions(+), 35 deletions(-)
diff --git a/README.adoc b/README.adoc
index 668b93f2d8..32aca1377d 100644
--- a/README.adoc
+++ b/README.adoc
@@ -120,7 +120,7 @@ link:docs/modules/development/pages/deployment-tests.adoc[This page] details how
James comes with a https://james.apache.org/documentation.html[Documentation] and https://github.com/linagora/james-project/tree/master/src/adr[Architectural Decision Records].
A more precise description of the *Distributed Server* architecture can be found
-link:https://james.staged.apache.org/james-distributed-app/3.7.4/architecture/index.html[here].
+link:https://james.staged.apache.org/james-distributed-app/3.8.0/architecture/index.html[here].
== Articles for James community
diff --git a/docs/antora.yml b/docs/antora.yml
index 1482356e95..6c1e37e8e0 100644
--- a/docs/antora.yml
+++ b/docs/antora.yml
@@ -1,6 +1,6 @@
name: james-project
title: Apache James Server
-version: '3.7.4'
+version: '3.8.0'
prerelease: SNAPSHOT
nav:
- modules/concepts/nav.adoc
diff --git a/server/apps/distributed-app/docs/antora.yml b/server/apps/distributed-app/docs/antora.yml
index 832fc8dea2..2c910ce6dc 100644
--- a/server/apps/distributed-app/docs/antora.yml
+++ b/server/apps/distributed-app/docs/antora.yml
@@ -1,6 +1,6 @@
name: james-distributed-app
title: Apache James Distributed Server
-version: '3.7.4'
+version: '3.8.0'
prerelease: SNAPSHOT
nav:
- modules/ROOT/nav.adoc
diff --git a/server/apps/distributed-app/docs/modules/ROOT/pages/operate/index.adoc b/server/apps/distributed-app/docs/modules/ROOT/pages/operate/index.adoc
index e3d2816cd5..4d45d27a34 100644
--- a/server/apps/distributed-app/docs/modules/ROOT/pages/operate/index.adoc
+++ b/server/apps/distributed-app/docs/modules/ROOT/pages/operate/index.adoc
@@ -34,25 +34,22 @@ This section sums up and links upgrade instructions for people willing to upgrad
|===
| Upgrade from | Recommended upgrade path to 3.7.4
-| 3.7.0 - 3.7.3
-| Rolling upgrade to 3.7.3. No specific upgrade instructions to perform.
+| 3.7.0 - 3.7.4
+| Upgrade, and apply link:https://github.com/apache/james-project/blob/master/upgrade-instructions.md#380-version[3.8.0 upgrade instructions]
-| 3.6.2
-| Rolling upgrade to 3.7.4. No specific upgrade instructions to perform.
+| 3.6.0 - 3.6.2
+| 1. Upgrade, and apply link:https://github.com/apache/james-project/blob/master/upgrade-instructions.md#370-version[3.7.0 upgrade instructions]
-| 3.6.1
-| Rolling upgrade to 3.7.4. No specific upgrade instructions to perform.
-
-| 3.6.0
-| Rolling upgrade to 3.7.4. No specific upgrade instructions to perform.
+2. Upgrade, and apply link:https://github.com/apache/james-project/blob/master/upgrade-instructions.md#380-version[3.8.0 upgrade instructions]
| 3.5.0
| 1. Upgrade, and apply link:https://github.com/apache/james-project/blob/master/upgrade-instructions.md#360-version[3.6.0 upgrade instructions]
Note: Because of ElasticSearch upgrade (6.3 -> 7.10) this migration cannot be done in a rolling fashion manner.
-2. Rolling upgrade to 3.7.4. No specific upgrade instructions to perform.
+2. Upgrade, and apply link:https://github.com/apache/james-project/blob/master/upgrade-instructions.md#370-version[3.7.0 upgrade instructions]
+3. Upgrade, and apply link:https://github.com/apache/james-project/blob/master/upgrade-instructions.md#380-version[3.8.0 upgrade instructions]
| 3.4.0
| 1. Rolling upgrade to 3.5.0, and apply link:https://github.com/apache/james-project/blob/master/upgrade-instructions.md#350-version[3.5.0 upgrade instructions]
@@ -61,7 +58,10 @@ Note: Because of ElasticSearch upgrade (6.3 -> 7.10) this migration cannot be do
Note: Because of ElasticSearch upgrade (6.3 -> 7.10) this migration cannot be done in a rolling fashion manner.
-3. Rolling upgrade to 3.7.4. No specific upgrade instructions to perform.
+3. Upgrade, and apply link:https://github.com/apache/james-project/blob/master/upgrade-instructions.md#370-version[3.7.0 upgrade instructions]
+
+4. Upgrade, and apply link:https://github.com/apache/james-project/blob/master/upgrade-instructions.md#380-version[3.8.0 upgrade instructions]
+
| 3.3.0
| 1. upgrade to 3.4.0, and apply link:https://github.com/apache/james-project/blob/master/upgrade-instructions.md#340-version[3.4.0 upgrade instructions]
@@ -74,6 +74,8 @@ Note: Because of ElasticSearch upgrade (2.2 -> 6.3) this migration cannot be do
Note: Because of ElasticSearch upgrade (6.3 -> 7.10) this migration cannot be done in a rolling fashion manner.
-4. Rolling upgrade to 3.7.4. No specific upgrade instructions to perform.
+4. Upgrade, and apply link:https://github.com/apache/james-project/blob/master/upgrade-instructions.md#370-version[3.7.0 upgrade instructions]
+
+5. Upgrade, and apply link:https://github.com/apache/james-project/blob/master/upgrade-instructions.md#380-version[3.8.0 upgrade instructions]
|===
diff --git a/server/apps/distributed-app/docs/modules/ROOT/pages/run/k8s-values.adoc b/server/apps/distributed-app/docs/modules/ROOT/pages/run/k8s-values.adoc
index f1cf0ddee4..54e446ae22 100644
--- a/server/apps/distributed-app/docs/modules/ROOT/pages/run/k8s-values.adoc
+++ b/server/apps/distributed-app/docs/modules/ROOT/pages/run/k8s-values.adoc
@@ -31,7 +31,7 @@ JMAP instance in the cluster
|replicaImapSmtpInstanceCount |1 |The number of pods we deploy for James
IMAP/SMTP instance in the cluster
-|image |apache/james:distributed-3.7.4 |The James image used for
+|image |apache/james:distributed-3.8.0 |The James image used for
deployment (Cassandra - RabbitMQ - LDAP distributed James flavor)
|===
diff --git a/server/apps/distributed-app/docs/modules/ROOT/pages/run/run-docker.adoc b/server/apps/distributed-app/docs/modules/ROOT/pages/run/run-docker.adoc
index 449ac3039d..b3a97f44e5 100644
--- a/server/apps/distributed-app/docs/modules/ROOT/pages/run/run-docker.adoc
+++ b/server/apps/distributed-app/docs/modules/ROOT/pages/run/run-docker.adoc
@@ -44,7 +44,7 @@ Then load the distributed server docker image:
Alternatively we provide convenience distribution for the latest release:
- docker pull apache/james:distributed-3.7.4
+ docker pull apache/james:distributed-3.8.0
=== Running
Firstly, create your own user network on Docker for the James environment:
@@ -76,7 +76,7 @@ You can find more explanation on the need of Tika in this xref:configure/tika.ad
To run this container :
$ docker run --network james --hostname HOSTNAME -p "25:25" -p 80:80 -p "110:110" -p "143:143" -p "465:465" -p "587:587" -p "993:993" -p "127.0.0.1:8000:8000" --name james_run
- -v $PWD/keystore:/root/conf/keystore -t apache/james:distributed-3.7.4 --generate-keystore
+ -v $PWD/keystore:/root/conf/keystore -t apache/james:distributed-3.8.0 --generate-keystore
Where :
diff --git a/server/apps/distributed-app/helm-chart/james/values.yaml b/server/apps/distributed-app/helm-chart/james/values.yaml
index 0d05b55487..ee10968f9e 100644
--- a/server/apps/distributed-app/helm-chart/james/values.yaml
+++ b/server/apps/distributed-app/helm-chart/james/values.yaml
@@ -9,7 +9,7 @@ dns:
james:
replicaJmapInstanceCount: 1
replicaImapSmtpInstanceCount: 1
- image: apache/james:distributed-3.7.4
+ image: apache/james:distributed-3.8.0
## Environment for James
env:
jamesCassandraKeyspace: sandbox_james
diff --git a/src/homepage/index.html b/src/homepage/index.html
index 0923ca6a87..1bd312021d 100644
--- a/src/homepage/index.html
+++ b/src/homepage/index.html
@@ -119,14 +119,14 @@ layout: default
<ul class="james-ul no-padding">
<li class="post-template"><span class="long-arrow-right">→</span><span><b>
WHAT WILL YOU TRY:</b><br>
- <span>Here you will try James server v 3.7.4 thanks to an image. This James image has a default configuration
+ <span>Here you will try James server v 3.8.0 thanks to an image. This James image has a default configuration
using JPA (hsqldb) and Lucene. It also includes a default domain named james.local and three default users:
user01@james.local, user02@james.local, user03@james.local, with their default password being <i>1234</i>.<br>
<i>Note: this James server will respond to IMAPS port 993 and SMTPS port 465.</i></span></span>
</li>
<li class="post-template"><span class="long-arrow-right">→</span><span><b>STEPS YOU HAVE TO FOLLOW:</b><br>
Pull and run the James image with the following single command:<br><br>
- <code class="highlighter-rouge">docker run -p "465:465" -p "993:993" apache/james:demo-3.7.4</code>
+ <code class="highlighter-rouge">docker run -p "465:465" -p "993:993" apache/james:demo-3.8.0</code>
<br><br>
Then, connect this image with for instance, Thunderbird. This <a href="howTo/imap-server.html">tutorial</a> covers more in depth user and domain creation,
@@ -168,7 +168,7 @@ WHAT WILL YOU TRY:</b><br>
<li class="post-template"><span><b>INCOMING WORK</b><br>
<ul>
<li><span class="long-arrow-right">→</span><span>Rework our documentation with <a href="https://antora.org/">Antora</a>,
- specify it on a per-server basis for ease of use. <a href="https://james.staged.apache.org/james-project/3.7.4/servers/index.html">Preview</a>...<br/>
+ specify it on a per-server basis for ease of use. <a href="https://james.staged.apache.org/james-project/3.8.0/servers/index.html">Preview</a>...<br/>
We will furthermore target servers to identified use cases, formulated in non technical terms: Basic Server, Advanced Server and Distributed Server.<br/></span></li>
<li><span class="long-arrow-right">→</span><span>Promote guice based applications.<br/>
Spring server will be deprecated. A summary of community call describing this item can be found
diff --git a/src/site/markdown/mailet/quickstart.md b/src/site/markdown/mailet/quickstart.md
index 7438c9cfd1..1aa86c70fe 100644
--- a/src/site/markdown/mailet/quickstart.md
+++ b/src/site/markdown/mailet/quickstart.md
@@ -20,7 +20,7 @@ Just include something like this in your *pom.xml*
<dependency>
<groupId>org.apache.james</groupId>
<artifactId>apache-mailet-api</artifactId>
- <version>3.7.4</version>
+ <version>3.8.0</version>
</dependency>
<!-- other dependencies -->
</dependencies>
diff --git a/src/site/xdoc/server/install.xml b/src/site/xdoc/server/install.xml
index b74c32d7e6..fcdf18dd75 100644
--- a/src/site/xdoc/server/install.xml
+++ b/src/site/xdoc/server/install.xml
@@ -29,11 +29,11 @@
<subsection name="Java Virtual Machine">
- <p>James 3.7.4 requires a Java Runtime Environment. Java version 11 is required to run the
+ <p>James 3.8.0 requires a Java Runtime Environment. Java version 11 is required to run the
James application. The exact JREs available depends on the platform. In addition, the environment variable JAVA_HOME should be set to
the JRE home directory before running James.</p>
- <p>James 3.7.4 has been successfully tested on OpenJDK 11</p>
+ <p>James 3.8.0 has been successfully tested on OpenJDK 11</p>
</subsection>
@@ -72,8 +72,8 @@
</section>
<section name="Build instructions">
- <p>Checkout code from the chosen version on <a href="https://github.com/apache/james-project/tree/james-project-3.7.4">
- GitHub</a>. Follow <a href="https://github.com/apache/james-project/blob/james-project-3.7.4/README.adoc">README instructions</a> about compilation.</p>
+ <p>Checkout code from the chosen version on <a href="https://github.com/apache/james-project/tree/james-project-3.8.0">
+ GitHub</a>. Follow <a href="https://github.com/apache/james-project/blob/james-project-3.8.0/README.adoc">README instructions</a> about compilation.</p>
<ul>Using these instructions, you can build the following images:
<li>Guice + JPA + Lucene</li>
diff --git a/src/site/xdoc/server/packaging.xml b/src/site/xdoc/server/packaging.xml
index 1c86add6f3..b6410fcd58 100644
--- a/src/site/xdoc/server/packaging.xml
+++ b/src/site/xdoc/server/packaging.xml
@@ -76,9 +76,9 @@
<tr>
<td>Docker image</td>
<td>Not available. Contributions welcomed for JIB support.</td>
- <td>apache/james:cassandra-3.7.4</td>
- <td>apache/james:distributed-3.7.4</td>
- <td>apache/james:jpa-3.7.4</td>
+ <td>apache/james:cassandra-3.8.0</td>
+ <td>apache/james:distributed-3.8.0</td>
+ <td>apache/james:jpa-3.8.0</td>
<td>None</td>
</tr>
<tr>
@@ -230,7 +230,7 @@
<th>Supported protocols</th>
</tr>
<tr>
- <td>apache/james:distributed-3.7.4</td>
+ <td>apache/james:distributed-3.8.0</td>
<td>Multi-node</td>
<td>Cassandra</td>
<td>S3 or Cassandra</td>
@@ -239,7 +239,7 @@
<td>SMTP, IMAP, JMAP, POP3, LMTP, WebAdmin</td>
</tr>
<tr>
- <td>apache/james:jpa-3.7.4</td>
+ <td>apache/james:jpa-3.8.0</td>
<td>Single node</td>
<td>Embedded Derby database (JPA, SQL)</td>
<td>Not applicable</td>
@@ -248,7 +248,7 @@
<td>SMTP, IMAP, POP3, LMTP, WebAdmin</td>
</tr>
<tr>
- <td>apache/james:demo-3.7.4</td>
+ <td>apache/james:demo-3.8.0</td>
<td>Pre-provisioned Single node instance to ease project discovery</td>
<td>Embedded Derby database (JPA, SQL)</td>
<td>Not applicable</td>
@@ -257,7 +257,7 @@
<td>SMTP, IMAP, POP3, LMTP, WebAdmin</td>
</tr>
<tr>
- <td>apache/james:memory-3.7.4</td>
+ <td>apache/james:memory-3.8.0</td>
<td>Single node for test purposes</td>
<td>Memory (no persistence)</td>
<td>Memory (no persistence)</td>
@@ -266,7 +266,7 @@
<td>SMTP, IMAP, JMAP, POP3, LMTP, WebAdmin</td>
</tr>
<tr>
- <td>apache/james:cassandra-3.7.4</td>
+ <td>apache/james:cassandra-3.8.0</td>
<td>Single node on top of a shared database</td>
<td>Cassandra</td>
<td>Cassandra</td>
diff --git a/src/site/xdoc/server/release-notes.xml b/src/site/xdoc/server/release-notes.xml
index 6cba0a655a..cc522b240d 100644
--- a/src/site/xdoc/server/release-notes.xml
+++ b/src/site/xdoc/server/release-notes.xml
@@ -39,6 +39,10 @@
of a <a href="https://github.com/apache/james-project/blob/master/CHANGELOG.md">changelog file</a>
as well as details <a href="https://github.com/apache/james-project/blob/master/upgrade-instructions.md">upgrade instructions</a>.</p>
</section>
+ <section name="Version 3.8.0">
+ <p>Released May 2023</p>
+ <p><a href="https://james.apache.org/james/update/2023/05/17/james-3.8.0.html">Read the release announce</a>. </p>
+ </section>
<section name="Version 3.7.4">
<p>Released March 2023</p>
<p><a href="https://james.apache.org/james/update/2023/03/20/james-3.7.4.html">Read the release announce</a>. </p>
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org