You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@james.apache.org by GitBox <gi...@apache.org> on 2021/09/14 13:20:06 UTC
[GitHub] [james-project] chibenwa opened a new pull request #654: Improvments for the README and Download page
chibenwa opened a new pull request #654:
URL: https://github.com/apache/james-project/pull/654
## Why
GitHub is an important place to get traction and READMEs are the primary document people look at.
They should be both informative AND easy to read.
My personnal feeling is that James README is polluted by too much information, not readable and misses most of the points.
The download page suffers similar flows.
I would like to improve the current situation with this humble PR.
## How
The goal is to keep the same level of information on the README but link external pages rather than polluting the README with content not pertinant for most readers.
Also I propose using badges at the top for important links: download, license, website, CI, documentation, docker hub, websites posts. Hopefully these contents would get more visibility.
I drastically simplified the index in the README that was clearly overcharged to me (takes more than my screen!) thus unreadable.
Finally I also sanitised the download page as stated in https://www.mail-archive.com/server-dev@james.apache.org/msg71016.html
## Preview
Preview these changes on my personnal repository: https://github.com/chibenwa/james-project/tree/improve-reame-14-09-2021
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-project] chibenwa commented on a change in pull request #654: Improvments for the README and Download page
Posted by GitBox <gi...@apache.org>.
chibenwa commented on a change in pull request #654:
URL: https://github.com/apache/james-project/pull/654#discussion_r710670045
##########
File path: src/site/markdown/server/manage-cli.md
##########
@@ -15,6 +15,12 @@ And for Guice distributions:
java -jar /root/james-cli.jar -h 127.0.0.1 -p 9999 COMMAND
```
+Guice in docker embed a script helper:
Review comment:
```suggestion
Guice in docker embeds a script helper:
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-project] chibenwa commented on a change in pull request #654: Improvments for the README and Download page
Posted by GitBox <gi...@apache.org>.
chibenwa commented on a change in pull request #654:
URL: https://github.com/apache/james-project/pull/654#discussion_r708917693
##########
File path: docs/modules/development/pages/deployment-tests.adoc
##########
@@ -0,0 +1,30 @@
+= How to run deployment Tests
+:navtitle: Deployment tests
+
+We wrote some MPT (James' Mail Protocols Tests subproject) deployment tests to validate a James
+deployment.
+
+It uses the External-James module, that uses environment variables to locate a remote
+IMAP server and run integration tests against it.
+
+For that, the target James Server needs to be configured with a domain `domain` and a user `imapuser`
+with password password. Read above documentation to see how you can do this.
Review comment:
```suggestion
with password `password`. Read above documentation to see how you can do this.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-project] chibenwa commented on a change in pull request #654: Improvments for the README and Download page
Posted by GitBox <gi...@apache.org>.
chibenwa commented on a change in pull request #654:
URL: https://github.com/apache/james-project/pull/654#discussion_r710669294
##########
File path: README.adoc
##########
@@ -36,173 +47,81 @@ https://issues.apache.org/jira/issues/?jql=project%20%3D%20JAMES%20AND%20resolut
https://issues.apache.org/jira/issues/?jql=project%20%3D%20JAMES%20AND%20resolution%20%3D%20Unresolved%20AND%20labels%20%3D%20feature%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC[~feature] labels on JIRA.
There is many other ways one can help us: packaging, communication, etc ...
-
-= How to...
-
- * link:#how-to-try-james[How to try James]
- * link:#how-to-check-the-compilation[How to check the compilation]
- * link:#how-to-run-james-in-docker[How to run James in Docker]
- ** link:#run-james-with-guice-%2Dcassandra-%2Drabbitmq-%2Ds3-%2Delasticsearch[Run James with Guice + Cassandra + RabbitMQ + S3 + ElasticSearch]
- ** link:#run-james-with-guice-%2Dcassandra-%2Delasticsearch[Run James with Guice + Cassandra + ElasticSearch]
- ** link:#run-james-with-guice-%2Djpa-%2Dlucene[Run James with Guice + JPA + Lucene]
- ** link:#run-james-with-spring-%2Djpa[Run James with Spring + JPA]
- * link:#other-useful-commands[Other Useful commands]
- ** link:#how-to-add-a-domain-[How to add a domain?]
- ** link:#how-to-add-a-user-[How to add a user?]
- ** link:#how-to-manage-sieve-scripts-[How to manage SIEVE scripts?]
- ** link:#how-to-retrieve-users-and-password-from-my-previous-container[How to retrieve users and password from my previous container?]
- * link:#develop-on-james[Develop on James]
- ** link:#how-to-run-deployment-tests[How to run deployment Tests]
- ** link:#how-to-check-the-merge-of-a-commit[How to check the merge of a commit]
- * link:#know-more-about-james-design[Know more about James design]
- * link:#articles-for-james-community[Articles for James community]
- ** link:#how-to-build-and-publish-the-website[How to build and publish the website]
- ** link:#how-to-release-via-maven-release-plugin[How to release via maven release plugin]
+====
== How to try James
-Requirements: docker & docker-compose installed.
-
-When you try James this way, you will use the most current state of James.
-It will be configured to run with Cassandra & ElasticSearch.
-All those three components will be started with a single command.
-
-You can retrieve the docker-compose file :
+.Read more...
+[%collapsible]
+====
+Requirements: `docker` installed.
- $ wget https://raw.githubusercontent.com/apache/james-project/master/server/apps/distributed-app/docker-compose.yml
+Here you will try James server v 3.6.0 thanks to a docker 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 1234.
-Then, you just have to start the services:
+Note: this James server will respond to IMAPS port 993 and SMTPS port 465.
- $ docker-compose up
+Pull and run the James image with the following single command :
Review comment:
```suggestion
Pull and run the James image with the following single command:
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-project] rouazana commented on a change in pull request #654: Improvments for the README and Download page
Posted by GitBox <gi...@apache.org>.
rouazana commented on a change in pull request #654:
URL: https://github.com/apache/james-project/pull/654#discussion_r709937050
##########
File path: src/site/markdown/server/manage-cli.md
##########
@@ -15,6 +15,12 @@ And for Guice distributions:
java -jar /root/james-cli.jar -h 127.0.0.1 -p 9999 COMMAND
```
+Guice in docker embed a script helper:
Review comment:
embeds? (suggestions are broken?)
##########
File path: README.adoc
##########
@@ -57,30 +57,24 @@ There is many other ways one can help us: packaging, communication, etc ...
== How to try James
-Requirements: docker & docker-compose installed.
+Requirements: `docker` installed.
-When you try James this way, you will use the most current state of James.
-It will be configured to run with Cassandra & ElasticSearch.
-All those three components will be started with a single command.
+Here you will try James server v 3.6.0 thanks to a docker image. This James image has a default configuration using JPA
Review comment:
v3.6.0 or version 3.6.0?
##########
File path: README.adoc
##########
@@ -57,30 +57,24 @@ There is many other ways one can help us: packaging, communication, etc ...
== How to try James
-Requirements: docker & docker-compose installed.
+Requirements: `docker` installed.
-When you try James this way, you will use the most current state of James.
-It will be configured to run with Cassandra & ElasticSearch.
-All those three components will be started with a single command.
+Here you will try James server v 3.6.0 thanks to a docker 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 1234.
-You can retrieve the docker-compose file :
+Note: this James server will respond to IMAPS port 993 and SMTPS port 465.
- $ wget https://raw.githubusercontent.com/apache/james-project/master/server/apps/distributed-app/docker-compose.yml
+Pull and run the James image with the following single command :
Review comment:
s/command :/command:/
##########
File path: README.adoc
##########
@@ -57,30 +57,24 @@ There is many other ways one can help us: packaging, communication, etc ...
== How to try James
-Requirements: docker & docker-compose installed.
+Requirements: `docker` installed.
-When you try James this way, you will use the most current state of James.
-It will be configured to run with Cassandra & ElasticSearch.
-All those three components will be started with a single command.
+Here you will try James server v 3.6.0 thanks to a docker 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 1234.
-You can retrieve the docker-compose file :
+Note: this James server will respond to IMAPS port 993 and SMTPS port 465.
- $ wget https://raw.githubusercontent.com/apache/james-project/master/server/apps/distributed-app/docker-compose.yml
+Pull and run the James image with the following single command :
-Then, you just have to start the services:
+ $ docker run -p "465:465" -p "993:993" apache/james:demo-3.6.0
- $ docker-compose up
+Then, connect this image with for instance, Thunderbird.
+link:https://james.apache.org/howTo/imap-server.html[This tutorial] covers more in depth user and domain creation, as well as thunderbird setup.
Review comment:
s/thunderbird/Thunderbird/
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-project] Arsnael commented on a change in pull request #654: Improvments for the README and Download page
Posted by GitBox <gi...@apache.org>.
Arsnael commented on a change in pull request #654:
URL: https://github.com/apache/james-project/pull/654#discussion_r708970241
##########
File path: README.adoc
##########
@@ -15,15 +20,21 @@ It has a modular architecture based on a rich set of *modern* and *efficient* co
Create your *own personal solution* for emails treatment by assembling the components you need thanks to the Inversion
of Control mail platform offered and go further customizing filtering and routing rules using *James Mailet Container*.
-Supported protocols are: IMAP, SMTP, JMAP, POP3 and more...
+Supported protocols are: IMAP, SMTP, link:https://jmap.io[JMAP], POP3 and more...
+
+The link:https://james.staged.apache.org/james-project/3.7.0/servers/distributed.html[*Distributed server*] focuses on delivering a easy-to-operate scalable mail server based on modern technologies
Review comment:
```suggestion
The link:https://james.staged.apache.org/james-project/3.7.0/servers/distributed.html[*Distributed server*] focuses on delivering an easy-to-operate scalable mail server based on modern technologies
```
##########
File path: docs/modules/servers/partials/ManageSieveMailet.adoc
##########
@@ -0,0 +1,13 @@
+=== Manage Sieve scripts via a mailet
+
+Each user can manage his SIEVE scripts through the `ManageSieveMailet` mailet.
+
+To use the manage SIEVE mailet :
+
+* You need to create the user sievemanager@DOMAIN ( if you don't, the SMTP server will check the domain, recognize it, and look for an absent local user, and will generate an error ).
+* You can send Manage Sieve commands by mail to sievemanager@DOMAIN. Your subject must contain the command. Scripts needs to be added as attachments and need the ".sieve" extension.
Review comment:
```suggestion
* You can send Manage Sieve commands by mail to sievemanager@DOMAIN. Your subject must contain the command. Scripts need to be added as attachments and need the ".sieve" extension.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-project] chibenwa edited a comment on pull request #654: Improvments for the README and Download page
Posted by GitBox <gi...@apache.org>.
chibenwa edited a comment on pull request #654:
URL: https://github.com/apache/james-project/pull/654#issuecomment-919154505
https://github.com/chibenwa/james-project/tree/improve-reame-14-09-2021-2 uses collapsible sections to get a really concise easy to read readme and get rid of the index section.
Should we consider adopt this here too?
(cc @rouazana maybe? )
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-project] chibenwa commented on a change in pull request #654: Improvments for the README and Download page
Posted by GitBox <gi...@apache.org>.
chibenwa commented on a change in pull request #654:
URL: https://github.com/apache/james-project/pull/654#discussion_r710669202
##########
File path: README.adoc
##########
@@ -36,173 +47,81 @@ https://issues.apache.org/jira/issues/?jql=project%20%3D%20JAMES%20AND%20resolut
https://issues.apache.org/jira/issues/?jql=project%20%3D%20JAMES%20AND%20resolution%20%3D%20Unresolved%20AND%20labels%20%3D%20feature%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC[~feature] labels on JIRA.
There is many other ways one can help us: packaging, communication, etc ...
-
-= How to...
-
- * link:#how-to-try-james[How to try James]
- * link:#how-to-check-the-compilation[How to check the compilation]
- * link:#how-to-run-james-in-docker[How to run James in Docker]
- ** link:#run-james-with-guice-%2Dcassandra-%2Drabbitmq-%2Ds3-%2Delasticsearch[Run James with Guice + Cassandra + RabbitMQ + S3 + ElasticSearch]
- ** link:#run-james-with-guice-%2Dcassandra-%2Delasticsearch[Run James with Guice + Cassandra + ElasticSearch]
- ** link:#run-james-with-guice-%2Djpa-%2Dlucene[Run James with Guice + JPA + Lucene]
- ** link:#run-james-with-spring-%2Djpa[Run James with Spring + JPA]
- * link:#other-useful-commands[Other Useful commands]
- ** link:#how-to-add-a-domain-[How to add a domain?]
- ** link:#how-to-add-a-user-[How to add a user?]
- ** link:#how-to-manage-sieve-scripts-[How to manage SIEVE scripts?]
- ** link:#how-to-retrieve-users-and-password-from-my-previous-container[How to retrieve users and password from my previous container?]
- * link:#develop-on-james[Develop on James]
- ** link:#how-to-run-deployment-tests[How to run deployment Tests]
- ** link:#how-to-check-the-merge-of-a-commit[How to check the merge of a commit]
- * link:#know-more-about-james-design[Know more about James design]
- * link:#articles-for-james-community[Articles for James community]
- ** link:#how-to-build-and-publish-the-website[How to build and publish the website]
- ** link:#how-to-release-via-maven-release-plugin[How to release via maven release plugin]
+====
== How to try James
-Requirements: docker & docker-compose installed.
-
-When you try James this way, you will use the most current state of James.
-It will be configured to run with Cassandra & ElasticSearch.
-All those three components will be started with a single command.
-
-You can retrieve the docker-compose file :
+.Read more...
+[%collapsible]
+====
+Requirements: `docker` installed.
- $ wget https://raw.githubusercontent.com/apache/james-project/master/server/apps/distributed-app/docker-compose.yml
+Here you will try James server v 3.6.0 thanks to a docker image. This James image has a default configuration using JPA
Review comment:
```suggestion
Here you will try James server version 3.6.0 thanks to a docker image. This James image has a default configuration using JPA
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-project] chibenwa commented on a change in pull request #654: Improvments for the README and Download page
Posted by GitBox <gi...@apache.org>.
chibenwa commented on a change in pull request #654:
URL: https://github.com/apache/james-project/pull/654#discussion_r708917023
##########
File path: docs/modules/development/pages/deployment-tests.adoc
##########
@@ -0,0 +1,30 @@
+= How to run deployment Tests
+:navtitle: Deployment tests
+
+We wrote some MPT (James' Mail Protocols Tests subproject) deployment tests to validate a James
+deployment.
+
+It uses the External-James module, that uses environment variables to locate a remote
+IMAP server and run integration tests against it.
+
+For that, the target James Server needs to be configured with a domain domain and a user imapuser
Review comment:
```suggestion
For that, the target James Server needs to be configured with a domain `domain` and a user `imapuser`
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-project] chibenwa merged pull request #654: Improvments for the README and Download page
Posted by GitBox <gi...@apache.org>.
chibenwa merged pull request #654:
URL: https://github.com/apache/james-project/pull/654
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-project] chibenwa commented on a change in pull request #654: Improvments for the README and Download page
Posted by GitBox <gi...@apache.org>.
chibenwa commented on a change in pull request #654:
URL: https://github.com/apache/james-project/pull/654#discussion_r710669383
##########
File path: README.adoc
##########
@@ -36,173 +47,81 @@ https://issues.apache.org/jira/issues/?jql=project%20%3D%20JAMES%20AND%20resolut
https://issues.apache.org/jira/issues/?jql=project%20%3D%20JAMES%20AND%20resolution%20%3D%20Unresolved%20AND%20labels%20%3D%20feature%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC[~feature] labels on JIRA.
There is many other ways one can help us: packaging, communication, etc ...
-
-= How to...
-
- * link:#how-to-try-james[How to try James]
- * link:#how-to-check-the-compilation[How to check the compilation]
- * link:#how-to-run-james-in-docker[How to run James in Docker]
- ** link:#run-james-with-guice-%2Dcassandra-%2Drabbitmq-%2Ds3-%2Delasticsearch[Run James with Guice + Cassandra + RabbitMQ + S3 + ElasticSearch]
- ** link:#run-james-with-guice-%2Dcassandra-%2Delasticsearch[Run James with Guice + Cassandra + ElasticSearch]
- ** link:#run-james-with-guice-%2Djpa-%2Dlucene[Run James with Guice + JPA + Lucene]
- ** link:#run-james-with-spring-%2Djpa[Run James with Spring + JPA]
- * link:#other-useful-commands[Other Useful commands]
- ** link:#how-to-add-a-domain-[How to add a domain?]
- ** link:#how-to-add-a-user-[How to add a user?]
- ** link:#how-to-manage-sieve-scripts-[How to manage SIEVE scripts?]
- ** link:#how-to-retrieve-users-and-password-from-my-previous-container[How to retrieve users and password from my previous container?]
- * link:#develop-on-james[Develop on James]
- ** link:#how-to-run-deployment-tests[How to run deployment Tests]
- ** link:#how-to-check-the-merge-of-a-commit[How to check the merge of a commit]
- * link:#know-more-about-james-design[Know more about James design]
- * link:#articles-for-james-community[Articles for James community]
- ** link:#how-to-build-and-publish-the-website[How to build and publish the website]
- ** link:#how-to-release-via-maven-release-plugin[How to release via maven release plugin]
+====
== How to try James
-Requirements: docker & docker-compose installed.
-
-When you try James this way, you will use the most current state of James.
-It will be configured to run with Cassandra & ElasticSearch.
-All those three components will be started with a single command.
-
-You can retrieve the docker-compose file :
+.Read more...
+[%collapsible]
+====
+Requirements: `docker` installed.
- $ wget https://raw.githubusercontent.com/apache/james-project/master/server/apps/distributed-app/docker-compose.yml
+Here you will try James server v 3.6.0 thanks to a docker 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 1234.
-Then, you just have to start the services:
+Note: this James server will respond to IMAPS port 993 and SMTPS port 465.
- $ docker-compose up
+Pull and run the James image with the following single command :
-Wait a few seconds in order to have all those services start up. You will see the following log when James is available:
-james | Started : true
+ $ docker run -p "465:465" -p "993:993" apache/james:demo-3.6.0
-A default domain, james.local, has been created. You can see this by running:
+Then, connect this image with for instance, Thunderbird.
+link:https://james.apache.org/howTo/imap-server.html[This tutorial] covers more in depth user and domain creation, as well as thunderbird setup.
Review comment:
```suggestion
link:https://james.apache.org/howTo/imap-server.html[This tutorial] covers more in depth user and domain creation, as well as Thunderbird setup.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-project] chibenwa commented on pull request #654: Improvments for the README and Download page
Posted by GitBox <gi...@apache.org>.
chibenwa commented on pull request #654:
URL: https://github.com/apache/james-project/pull/654#issuecomment-919154505
https://github.com/chibenwa/james-project/tree/improve-reame-14-09-2021-2 uses collapsible sections to get a really cons=cise easy to read readme and get rid of the index section.
(cc @rouazana maybe? )
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-project] chibenwa commented on a change in pull request #654: Improvments for the README and Download page
Posted by GitBox <gi...@apache.org>.
chibenwa commented on a change in pull request #654:
URL: https://github.com/apache/james-project/pull/654#discussion_r708916128
##########
File path: README.adoc
##########
@@ -5,7 +5,7 @@ image:https://img.shields.io/badge/Join%20us-Mailing%20lists-purple.svg[link="ht
link:https://gitter.im/apache/james-project[image:https://badges.gitter.im/apache/james-project.svg[Join the chat at link:https://gitter.im/apache/james-project]]
image:https://img.shields.io/badge/CI-Jenkins%40Apache-blue.svg[link="https://ci-builds.apache.org/job/james/job/ApacheJames/"]
image:https://img.shields.io/badge/Documentation-green.svg[link="https://james.apache.org/documentation.html"]
-image:https://img.shields.io/badge/Downloads-yellow.svg[link="https://james.apache.org/download.cgi"]
+image:https://img.shields.io/badge/Downloads-3.6.0-yellow.svg[link="https://james.apache.org/download.cgi"]
Review comment:
Don't point directly to Apache hosting, we should encourage using the mirrors
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-project] chibenwa commented on a change in pull request #654: Improvments for the README and Download page
Posted by GitBox <gi...@apache.org>.
chibenwa commented on a change in pull request #654:
URL: https://github.com/apache/james-project/pull/654#discussion_r708919237
##########
File path: docs/modules/development/pages/deployment-tests.adoc
##########
@@ -0,0 +1,30 @@
+= How to run deployment Tests
+:navtitle: Deployment tests
+
+We wrote some MPT (James' Mail Protocols Tests subproject) deployment tests to validate a James
+deployment.
+
+It uses the External-James module, that uses environment variables to locate a remote
+IMAP server and run integration tests against it.
+
+For that, the target James Server needs to be configured with a domain `domain` and a user `imapuser`
+with password `password`. Read above documentation to see how you can do this.
+
+You have to run MPT tests inside docker. As you need to use maven, the simplest option is to
+use james/parent image, and override the entry point ( as git and maven are already configured
+there ) :
+
+ $ export JAMES_ADDRESS=127.0.0.1
+ $ export JAMES_IMAP_PORT=143
+ $ export JAMES_SMTP_PORT=25
+
+ $ mvn -T 1C -DskipTests -pl org.apache.james:apache-james-mpt-external-james -am install
+ $ mvn -T 1C -pl org.apache.james:apache-james-mpt-external-james test -Pintegration-tests\
Review comment:
```suggestion
$ mvn -T 1C -pl org.apache.james:apache-james-mpt-external-james test -Pintegration-tests
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-project] vttranlina commented on a change in pull request #654: Improvments for the README and Download page
Posted by GitBox <gi...@apache.org>.
vttranlina commented on a change in pull request #654:
URL: https://github.com/apache/james-project/pull/654#discussion_r708907220
##########
File path: docs/modules/development/pages/deployment-tests.adoc
##########
@@ -0,0 +1,30 @@
+= How to run deployment Tests
+:navtitle: Deployment tests
+
+We wrote some MPT (James' Mail Protocols Tests subproject) deployment tests to validate a James
+deployment.
+
+It uses the External-James module, that uses environment variables to locate a remote
+IMAP server and run integration tests against it.
+
+For that, the target James Server needs to be configured with a domain domain and a user imapuser
Review comment:
double `domain`
##########
File path: docs/modules/development/pages/deployment-tests.adoc
##########
@@ -0,0 +1,30 @@
+= How to run deployment Tests
+:navtitle: Deployment tests
+
+We wrote some MPT (James' Mail Protocols Tests subproject) deployment tests to validate a James
+deployment.
+
+It uses the External-James module, that uses environment variables to locate a remote
+IMAP server and run integration tests against it.
+
+For that, the target James Server needs to be configured with a domain domain and a user imapuser
+with password password. Read above documentation to see how you can do this.
Review comment:
double `password`
##########
File path: docs/modules/development/pages/deployment-tests.adoc
##########
@@ -0,0 +1,30 @@
+= How to run deployment Tests
+:navtitle: Deployment tests
+
+We wrote some MPT (James' Mail Protocols Tests subproject) deployment tests to validate a James
+deployment.
+
+It uses the External-James module, that uses environment variables to locate a remote
+IMAP server and run integration tests against it.
+
+For that, the target James Server needs to be configured with a domain domain and a user imapuser
+with password password. Read above documentation to see how you can do this.
+
+You have to run MPT tests inside docker. As you need to use maven, the simplest option is to
+use james/parent image, and override the entry point ( as git and maven are already configured
+there ) :
+
+ $ export JAMES_ADDRESS=127.0.0.1
+ $ export JAMES_IMAP_PORT=143
+ $ export JAMES_SMTP_PORT=25
+
+ $ mvn -T 1C -DskipTests -pl org.apache.james:apache-james-mpt-external-james -am install
+ $ mvn -T 1C -pl org.apache.james:apache-james-mpt-external-james test -Pintegration-tests\
Review comment:
remove " \ "
##########
File path: README.adoc
##########
@@ -5,7 +5,7 @@ image:https://img.shields.io/badge/Join%20us-Mailing%20lists-purple.svg[link="ht
link:https://gitter.im/apache/james-project[image:https://badges.gitter.im/apache/james-project.svg[Join the chat at link:https://gitter.im/apache/james-project]]
image:https://img.shields.io/badge/CI-Jenkins%40Apache-blue.svg[link="https://ci-builds.apache.org/job/james/job/ApacheJames/"]
image:https://img.shields.io/badge/Documentation-green.svg[link="https://james.apache.org/documentation.html"]
-image:https://img.shields.io/badge/Downloads-yellow.svg[link="https://james.apache.org/download.cgi"]
+image:https://img.shields.io/badge/Downloads-3.6.0-yellow.svg[link="https://james.apache.org/download.cgi"]
Review comment:
Should we use https://archive.apache.org/dist/james/server/3.6.0/ ?
##########
File path: README.adoc
##########
@@ -93,7 +93,7 @@ Useful options includes:
== How to run James in Docker
-This feature is available for three configurations :
+We maintain docker distribution for our Guice based applications :
Review comment:
```suggestion
We maintain docker distribution for our link:https://github.com/google/guice[Guice] based applications:
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org