You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by ma...@apache.org on 2020/05/11 09:54:03 UTC
[james-project] branch master updated: [documentation] Initial
version of Antora documentation
This is an automated email from the ASF dual-hosted git repository.
matthieu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git
The following commit(s) were added to refs/heads/master by this push:
new 5a2921c [documentation] Initial version of Antora documentation
new 0018e5c Merge pull request #189 from dleangen/documentation
5a2921c is described below
commit 5a2921c5d326e754a3ce668cde99ebed6105f949
Author: David Leangen <da...@leangen.net>
AuthorDate: Tue May 5 21:53:07 2020 +0900
[documentation] Initial version of Antora documentation
---
docs/antora.yml | 10 ++++++++++
docs/modules/ROOT/nav.adoc | 1 +
docs/modules/ROOT/pages/index.adoc | 15 +++++++++++++++
docs/modules/admin/nav.adoc | 1 +
docs/modules/admin/pages/index.adoc | 4 ++++
docs/modules/dev/nav.adoc | 1 +
docs/modules/dev/pages/index.adoc | 4 ++++
docs/modules/doc/nav.adoc | 1 +
docs/modules/doc/pages/index.adoc | 11 +++++++++++
docs/modules/ops/nav.adoc | 1 +
docs/modules/ops/pages/index.adoc | 4 ++++
docs/modules/user/nav.adoc | 4 ++++
docs/modules/user/pages/build.adoc | 4 ++++
docs/modules/user/pages/index.adoc | 23 +++++++++++++++++++++++
docs/modules/user/pages/learn.adoc | 4 ++++
docs/modules/user/pages/try.adoc | 27 +++++++++++++++++++++++++++
16 files changed, 115 insertions(+)
diff --git a/docs/antora.yml b/docs/antora.yml
new file mode 100644
index 0000000..a7cff65
--- /dev/null
+++ b/docs/antora.yml
@@ -0,0 +1,10 @@
+name: main
+title: Apache James Reference Book
+version: '3.5'
+prerelease: Alpha
+nav:
+- modules/user/nav.adoc
+- modules/ops/nav.adoc
+- modules/admin/nav.adoc
+- modules/dev/nav.adoc
+- modules/doc/nav.adoc
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
new file mode 100644
index 0000000..94db0dc
--- /dev/null
+++ b/docs/modules/ROOT/nav.adoc
@@ -0,0 +1 @@
+* Apache James Reference Book
diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
new file mode 100644
index 0000000..b0fd779
--- /dev/null
+++ b/docs/modules/ROOT/pages/index.adoc
@@ -0,0 +1,15 @@
+= Welcome
+
+Welcome to the Apache James Reference Book! This Book is for version {page-version} of James.
+
+Apache James is the **J**ava **A**pache **M**ail **E**nterprise **S**erver. It boasts of a modular architecture based on a rich set of components that run on the JVM. With James, you can create your own custom enterprise email solution.
+
+This Reference Book is divided into the following Parts:
+
+* xref:main:user:index.adoc[User Manual]
+* xref:main:ops:index.adoc[Operator Manual]
+* xref:main:admin:index.adoc[Administrator Guide]
+* xref:main:dev:index.adoc[Developer Resources]
+* xref:main:doc:index.adoc[About this documentation]
+
+Please note that this Reference Book is a **living document**. It is subject to change. You are currently reading version {page-version}. If you find anything that is unclear, unfinished, or confusing, please do not hestiate to xref:main:doc:index.adoc[lend us a hand].
diff --git a/docs/modules/admin/nav.adoc b/docs/modules/admin/nav.adoc
new file mode 100644
index 0000000..31f850e
--- /dev/null
+++ b/docs/modules/admin/nav.adoc
@@ -0,0 +1 @@
+* xref:index.adoc[]
diff --git a/docs/modules/admin/pages/index.adoc b/docs/modules/admin/pages/index.adoc
new file mode 100644
index 0000000..53ed8f0
--- /dev/null
+++ b/docs/modules/admin/pages/index.adoc
@@ -0,0 +1,4 @@
+= Apache James Administrator Guide
+:navtitle: Administrator Guide
+
+(TODO)
diff --git a/docs/modules/dev/nav.adoc b/docs/modules/dev/nav.adoc
new file mode 100644
index 0000000..31f850e
--- /dev/null
+++ b/docs/modules/dev/nav.adoc
@@ -0,0 +1 @@
+* xref:index.adoc[]
diff --git a/docs/modules/dev/pages/index.adoc b/docs/modules/dev/pages/index.adoc
new file mode 100644
index 0000000..db73ae1
--- /dev/null
+++ b/docs/modules/dev/pages/index.adoc
@@ -0,0 +1,4 @@
+= Apache James Developer Resources
+:navtitle: Developer Resources
+
+(TODO)
diff --git a/docs/modules/doc/nav.adoc b/docs/modules/doc/nav.adoc
new file mode 100644
index 0000000..31f850e
--- /dev/null
+++ b/docs/modules/doc/nav.adoc
@@ -0,0 +1 @@
+* xref:index.adoc[]
diff --git a/docs/modules/doc/pages/index.adoc b/docs/modules/doc/pages/index.adoc
new file mode 100644
index 0000000..163a381
--- /dev/null
+++ b/docs/modules/doc/pages/index.adoc
@@ -0,0 +1,11 @@
+= About this documentation
+:navtitle: About this documentation
+
+This documentation was produced with Antora.
+
+We know that this documentation is lacking. We are slowing working on making it better.
+To that end, we would **love** to get your help!
+
+This section explains how to work with Antora and the Apache James Reference Book.
+
+(TODO)
diff --git a/docs/modules/ops/nav.adoc b/docs/modules/ops/nav.adoc
new file mode 100644
index 0000000..31f850e
--- /dev/null
+++ b/docs/modules/ops/nav.adoc
@@ -0,0 +1 @@
+* xref:index.adoc[]
diff --git a/docs/modules/ops/pages/index.adoc b/docs/modules/ops/pages/index.adoc
new file mode 100644
index 0000000..d11c829
--- /dev/null
+++ b/docs/modules/ops/pages/index.adoc
@@ -0,0 +1,4 @@
+= Apache James Operator Manual
+:navtitle: Operator Manual
+
+(TODO)
diff --git a/docs/modules/user/nav.adoc b/docs/modules/user/nav.adoc
new file mode 100644
index 0000000..e4377a6
--- /dev/null
+++ b/docs/modules/user/nav.adoc
@@ -0,0 +1,4 @@
+* xref:index.adoc[]
+** xref:try.adoc[]
+** xref:learn.adoc[]
+** xref:build.adoc[]
diff --git a/docs/modules/user/pages/build.adoc b/docs/modules/user/pages/build.adoc
new file mode 100644
index 0000000..28e483a
--- /dev/null
+++ b/docs/modules/user/pages/build.adoc
@@ -0,0 +1,4 @@
+= Build your own custom mail server
+:navtitle: Build
+
+(TODO)
diff --git a/docs/modules/user/pages/index.adoc b/docs/modules/user/pages/index.adoc
new file mode 100644
index 0000000..418db0d
--- /dev/null
+++ b/docs/modules/user/pages/index.adoc
@@ -0,0 +1,23 @@
+= Apache James User Manual
+:navtitle: User Manual
+
+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::james-logo.png[James logo]
+
+*James* stands for *Java Apache Mail Enterprise Server*.
+
+James has a modular architecture based on a rich set of components that form a
+complete, stable, secure and customizable mail server running on the JVM.
+
+Supported protocols include: IMAP, SMTP, JMAP, and POP3.
+
+This user manual provides information to get you up and running quickly with James.
+You can also refer to the Administrator Guide, Developer Resources, and
+Operator Manual for additional information about James from different perspectives.
+
+== How to...
+
+ * Try James in 5 minutes
+ * Learn more about the architecture
+ * Build your own custom mail server
diff --git a/docs/modules/user/pages/learn.adoc b/docs/modules/user/pages/learn.adoc
new file mode 100644
index 0000000..543ea00
--- /dev/null
+++ b/docs/modules/user/pages/learn.adoc
@@ -0,0 +1,4 @@
+= Learn more about the architecture
+:navtitle: Learn
+
+You can read about James in the https://james.apache.org/documentation.html[Documentation] section on the James website.
diff --git a/docs/modules/user/pages/try.adoc b/docs/modules/user/pages/try.adoc
new file mode 100644
index 0000000..3fedab2
--- /dev/null
+++ b/docs/modules/user/pages/try.adoc
@@ -0,0 +1,27 @@
+= Try James in 5 minutes
+:navtitle: Try
+
+Requirements:
+
+ * Docker
+ * Docker-compose
+
+Retrieve the docker-compose file:
+
+ $ wget https://raw.githubusercontent.com/apache/james-project/master/dockerfiles/run/docker-compose.yml
+
+Start:
+
+ $ docker-compose up
+
+When James is available:
+
+james | Started : true
+
+A default domain, james.local, has been created. You can see this by running:
+
+ $ docker exec james java -jar /root/james-cli.jar -h 127.0.0.1 -p 9999 listdomains
+
+James will respond to IMAP port 143 and SMTP port 25.
+You have to create users before playing with james. You may also want to create other domains.
+Follow the 'Useful commands' section for more information about James CLI.
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org