This is an automated email from the ASF dual-hosted git repository.
chibenwa pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-jspf.git
commit 92ea66abbfcba14ab326c190d7be8561f7d04f7f
Author: Benoit TELLIER <[email protected]>
AuthorDate: Sun Aug 23 23:06:27 2026 +0700
[DOC] Migrate content to Antora
---
docs/antora.yml | 2 +
docs/modules/ROOT/nav.adoc | 6 +++
docs/modules/ROOT/pages/code-standards.adoc | 41 ++++++++++++++++
docs/modules/ROOT/pages/faq.adoc | 5 ++
docs/modules/ROOT/pages/index.adoc | 73 ++++++++++++++++++++++++++++-
docs/modules/ROOT/pages/rfclist.adoc | 6 +++
6 files changed, 131 insertions(+), 2 deletions(-)
diff --git a/docs/antora.yml b/docs/antora.yml
index 22bb08f..72643aa 100644
--- a/docs/antora.yml
+++ b/docs/antora.yml
@@ -2,3 +2,5 @@ name: jspf
title: Apache James jSPF
version: '1.0.2-SNAPSHOT'
prerelease: true
+nav:
+ - modules/ROOT/nav.adoc
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
new file mode 100644
index 0000000..2e18dd3
--- /dev/null
+++ b/docs/modules/ROOT/nav.adoc
@@ -0,0 +1,6 @@
+* xref:index.adoc[Overview]
+* xref:faq.adoc[jSPF FAQ]
+* xref:rfclist.adoc[Useful RFCs]
+* xref:code-standards.adoc[Coding standards]
+* https://issues.apache.org/jira/browse/JSPF[Issue Tracker]
+* https://james.apache.org/download.cgi#Apache_jSPF[Download Releases]
diff --git a/docs/modules/ROOT/pages/code-standards.adoc b/docs/modules/ROOT/pages/code-standards.adoc
new file mode 100644
index 0000000..f8a1ee8
--- /dev/null
+++ b/docs/modules/ROOT/pages/code-standards.adoc
@@ -0,0 +1,41 @@
+= Coding standards
+
+Submissions to the James project must follow the coding conventions outlined in this
+document. James developers are asked to follow coding conventions already present in
+the code. (For example, if the existing code has the bracket on the same line as the
+`if` statement, then all subsequent code should also follow that convention.) Anything
+not explicitly mentioned in this document should adhere to the official
+https://www.oracle.com/java/technologies/javase/codeconventions-contents.html[Java Code Conventions].
+
+*Developers who commit code that does not follow the coding conventions outlined in
+this document will be responsible for fixing their own code.*
+
+. Spaces between parentheses are optional. The preference is to exclude extra spaces.
+Both of these conventions are acceptable:
++
+[source,java]
+----
+if (foo)
+
+or
+
+if ( foo )
+----
+
+. Four spaces. *NO tabs*. Period. The James mailing list receives commit messages that
+are almost impossible to read if tabs are used.
++
+In Emacs-speak, this translates to the following command:
++
+----
+(setq-default tab-width 4 indent-tabs-mode nil)
+----
+
+. Use Unix linefeeds for all `.java` source code files. Only platform-specific files
+(e.g. `.bat` files for Windows) should contain non-Unix linefeeds.
+
+. Javadoc *must* exist on all methods. Contributing a missing javadoc for any method,
+class, variable, etc., will be GREATLY appreciated as this will help to improve the
+James project.
+
+. The Apache License *MUST* be placed at the top of every file.
diff --git a/docs/modules/ROOT/pages/faq.adoc b/docs/modules/ROOT/pages/faq.adoc
new file mode 100644
index 0000000..de66417
--- /dev/null
+++ b/docs/modules/ROOT/pages/faq.adoc
@@ -0,0 +1,5 @@
+= Frequently asked questions
+
+== Can I run jSPF from the command line?
+
+Sure you can. Just enter `java -jar jspf-xxx.jar` to get the usage.
diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
index e3c7006..dd0a022 100644
--- a/docs/modules/ROOT/pages/index.adoc
+++ b/docs/modules/ROOT/pages/index.adoc
@@ -1,4 +1,73 @@
-= Apache James jSPF documentation
+= Apache James jSPF
+== What is it?
-TODO: This is a placeholder. Migrate older documentation.
+The jSPF library is a pure Java SPF implementation. It was designed to match the
+SPF specifications of 2006-2009 (see xref:rfclist.adoc[Useful RFCs]). SPF is also known as
+Sender Policy Framework. It was designed to detect email spoofing. This is the
+solution if you ever were tired of getting spam from yourself. For more information
+see the http://www.open-spf.org/[Open SPF website].
+
+== Releases
+
+Both binary and source distributions are available from the
+https://james.apache.org/download.cgi#Apache_jSPF[James download page].
+
+jSPF passes all YAML tests published by openspf.org, so it should be fully
+RFC 4408 compliant.
+
+== News
+
+=== 2010
+
+*Jun/2010 - jSPF-0.9.8 released*
+
+The JAMES Developer Team is proud to announce the
+https://james.apache.org/download.cgi#Apache_jSPF[availability] of APACHE jSPF-0.9.8.
+This release includes fixes for correct handling of TXT record escapings and passes
+the rfc4408-tests-2009.10 test suite.
+
+=== 2009
+
+*Jun/2009 - jSPF-0.9.7 released*
+
+After 1 year we are proud to announce the
+https://james.apache.org/download.cgi#Apache_jSPF[availability] of APACHE jSPF-0.9.7.
+This release includes fixes for correct handling of `$` signs in the local-part of
+email addresses and quotes in SPF records. It also includes a new version of dnsjnio
+which fixes a race condition when using the async mode of jSPF.
+
+=== 2008
+
+*Apr/2008 - jSPF-0.9.6 released*
+
+We are proud to announce the
+https://james.apache.org/download.cgi#Apache_jSPF[availability] of APACHE jSPF-0.9.6.
+This release fixes two possible NullPointerExceptions and handles the `exp=` modifier
+correctly.
+
+=== 2007
+
+*Sept/2007 - jSPF-0.9.5 released*
+
+We are proud to announce the
+https://james.apache.org/download.cgi#Apache_jSPF[availability] of APACHE jSPF-0.9.5.
+This release spots an initial support for asynchronous processing and is fully
+RFC 4408 compliant.
+
+*Feb/2007 - jSPF-0.9b4 released*
+
+After some more work was done, we are proud to announce the release of jSPF-0.9b4.
+0.9b4 correctly supports the SPF DNS record type (previously we only supported the TXT
+record type) and introduces support for SPF extension policies like fallback, override
+and trusted forwarder.
+
+=== 2006
+
+*Sep/2006 - jSPF-0.9b3 released*
+
+0.9b3 introduces YAML based unit tests to check RFC compliance and a couple of minor fixes.
+
+*Jul/2006 - First public release of jSPF*
+
+After a full rewrite of spf-java we finally release jSPF.
diff --git a/docs/modules/ROOT/pages/rfclist.adoc b/docs/modules/ROOT/pages/rfclist.adoc
new file mode 100644
index 0000000..d3ebe2d
--- /dev/null
+++ b/docs/modules/ROOT/pages/rfclist.adoc
@@ -0,0 +1,6 @@
+= Useful RFCs
+
+The SPF RFC implemented by jSPF:
+
+* https://datatracker.ietf.org/doc/html/rfc4408[RFC 4408] - Sender Policy Framework (SPF)
+for Authorizing Use of Domains in E-Mail, Version 1
lmpx.com only provides a reader for public news (NNTP) servers. It is not
affiliated with the servers or forums shown here and is not responsible for
the content of articles, which is written by their respective authors.