ISSUE-4 Simple documentation

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+
+## [Unreleased]
+
+### Added
+- ISSUE-1 Add a memory server application
+- ISSUE-6 Produce simple docker images with JIB

README.md

@@ -2,6 +2,42 @@
 
 This project adapts and enhance [Apache James project](https://james.apache.org)
 
+## Useful links
+
+ - We maintain a [CHANGELOG](CHANGELOG.md) and [upgrade instructions](upgrade-instructions.md)
+
+ - [Building + Running the memory server](openpaas-james/apps/memory/README.md)
+
+## Additional features
+
 Additional features includes:
  - JMAP PUSH over AMQP (WIP)
  - JMAP Filters/get and Filters/set (WIP)
+
+## Building the project
+
+This projects uses git submodules to track the latest branch of [the Apache James project](https://james.apache.org)
+
+After cloning this repository, you need to init the `james-project` submodule:
+
+```
+git submodule init
+git submodule update
+```
+
+It is possible that the `james-project` submodule is not in its latest state as well. If you want the latest changes
+of the Apache James project, you can run as well:
+
+```
+git submodule update --remote
+```
+
+**Note**: Don't hesitate to push the latest state of the submodule in a commit if it was not up-to-date!
+
+Then you can compile both `apache/james-project` and `linagora/openpaas-james` together.
+
+```
+mvn clean install -Dmaven.javadoc.skip=true
+```
+
+You can add the `-DskipTests` flag as well if you don't want to run the tests of the `apache/james-project`.

openpaas-james/apps/memory/README.md

@@ -0,0 +1,17 @@
+# openpaas-james Memory server
+
+This server, intended for testing, relies fully on lightweight memory
+datastructures.
+
+To build it:
+
+```
+mvn clean install
+mvn compile com.google.cloud.tools:jib-maven-plugin:2.7.0:dockerBuild
+```
+
+Then run it:
+
+```
+docker run linagora/openpaas-james-memory
+```

upgrade-instructions.md

@@ -0,0 +1,19 @@
+# Upgrade instructions
+
+This document covers every changes an Ops needs to be aware of when running OpenPaaS-James mail server.
+
+The following procedures are to take as it, and Linagora, nor its contributors, can not be 
+responsible for any damages generated by following the below procedures.
+
+Before performing these operations, you should ensure to have the skills to conduct the operations, and you should read other
+software documentation. Do not follow this guide blindly!
+
+## Unreleased
+
+Note: this section is in progress. It will be updated during all the development process until the release.
+
+Changes to apply between openpaas-1.9.x and openpaas-1.10.x will be reported here.
+
+Change list:
+
+(No changes yet.)