This is an automated email from the ASF dual-hosted git repository.
mawiesne pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/opennlp-site.git
The following commit(s) were added to refs/heads/main by this push:
new 5372829e updates jbake tech-stack so the maven build works on M1+
machines fixes inconsistent asciidoc style in various ad files beautifies
formatting in several enumerations for better readability and UX adds
`window=_blank` to many URLs in ad files adjusts ICLA ref to PDF version, as
icla.txt has been dropped permanently
5372829e is described below
commit 5372829ed760c38aa1177d08d5fd3a313305cea6
Author: Martin Wiesner <[email protected]>
AuthorDate: Fri Jun 9 19:14:04 2023 +0200
updates jbake tech-stack so the maven build works on M1+ machines
fixes inconsistent asciidoc style in various ad files
beautifies formatting in several enumerations for better readability and UX
adds `window=_blank` to many URLs in ad files
adjusts ICLA ref to PDF version, as icla.txt has been dropped permanently
---
pom.xml | 21 +++++++--------
src/main/jbake/content/building.ad | 6 ++---
src/main/jbake/content/code-conventions.ad | 12 +++++----
src/main/jbake/content/docs/index.ad | 2 +-
src/main/jbake/content/docs/legacy.ad | 36 ++++++++++++-------------
src/main/jbake/content/get-involved.ad | 10 +++----
src/main/jbake/content/mailing-lists.ad | 2 +-
src/main/jbake/content/maven-dependency.ad | 4 +--
src/main/jbake/content/news/release-170.ad | 7 ++---
src/main/jbake/content/news/release-171.ad | 14 +++++-----
src/main/jbake/content/news/release-172.ad | 5 ++--
src/main/jbake/content/news/release-180.ad | 4 +--
src/main/jbake/content/news/release-181.ad | 4 +--
src/main/jbake/content/news/release-182.ad | 2 +-
src/main/jbake/content/news/release-183.ad | 4 +--
src/main/jbake/content/news/release-184.ad | 4 +--
src/main/jbake/content/news/release-190.ad | 4 +--
src/main/jbake/content/news/release-191.ad | 2 +-
src/main/jbake/content/news/release-192.ad | 2 +-
src/main/jbake/content/news/release-193.ad | 2 +-
src/main/jbake/content/news/release-194.ad | 2 +-
src/main/jbake/content/news/release-200.ad | 4 +--
src/main/jbake/content/news/release-210.ad | 2 +-
src/main/jbake/content/news/release-211.ad | 2 +-
src/main/jbake/content/news/release-220.ad | 2 +-
src/main/jbake/content/release-model.ad | 43 +++++++++++++++---------------
src/main/jbake/content/release.ad | 12 +++++----
src/main/jbake/content/source-code.ad | 8 +++---
src/main/jbake/content/using-git.ad | 20 +++++++-------
29 files changed, 121 insertions(+), 121 deletions(-)
diff --git a/pom.xml b/pom.xml
index 49e3f2ce..2f2ac11c 100644
--- a/pom.xml
+++ b/pom.xml
@@ -35,9 +35,8 @@
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<maven.version>3.3.9</maven.version>
- <pegdown.version>1.6.0</pegdown.version>
- <asciidoctor.version>2.5.2</asciidoctor.version>
- <freemarker.version>2.3.25-incubating</freemarker.version>
+ <asciidoctor.version>2.5.10</asciidoctor.version>
+ <freemarker.version>2.3.32</freemarker.version>
</properties>
<build>
@@ -46,6 +45,7 @@
<plugins>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
+ <version>3.10.1</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
@@ -58,7 +58,6 @@
<!-- dependencies -->
<dependencies>
-
<!-- optional : a jbake version -->
<dependency>
<groupId>org.jbake</groupId>
@@ -71,18 +70,18 @@
<artifactId>freemarker</artifactId>
<version>${freemarker.version}</version>
</dependency>
- <!-- for markdown parsing (.md) -->
- <dependency>
- <groupId>org.pegdown</groupId>
- <artifactId>pegdown</artifactId>
- <version>${pegdown.version}</version>
- </dependency>
-
+ <!-- for ascii doc format (.ad) -->
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj</artifactId>
<version>${asciidoctor.version}</version>
</dependency>
+ <!-- Overriding orientdb, required to work on Apple Silicon (M1,..)
-->
+ <dependency>
+ <groupId>com.orientechnologies</groupId>
+ <artifactId>orientdb-core</artifactId>
+ <version>3.1.16</version>
+ </dependency>
</dependencies>
diff --git a/src/main/jbake/content/building.ad
b/src/main/jbake/content/building.ad
index 1309710f..ce600e32 100644
--- a/src/main/jbake/content/building.ad
+++ b/src/main/jbake/content/building.ad
@@ -26,13 +26,13 @@
### Prerequisites
- - If you have an IDE installed such as https://netbeans.org/[NetBeans] or
https://www.eclipse.org/[Eclipse] installed,
+ - If you have an IDE installed such as
https://netbeans.org/[NetBeans,window=_blank] or
https://www.eclipse.org/[Eclipse,window=_blank] installed,
it will make your development easier. However, follow on for the brave.
- - At least
https://www.oracle.com/technetwork/java/javase/overview/index.html[JDK 11] is
required to compile and run
+ - At least
https://www.oracle.com/technetwork/java/javase/overview/index.html[JDK
11,window=_blank] is required to compile and run
the object code.
- - At least https://maven.apache.org/[Apache Maven 3.3.9] is required to build
the source
+ - At least https://maven.apache.org/[Apache Maven 3.3.9,window=_blank] is
required to build the source
files and assemble the project.
### Build Procedure
diff --git a/src/main/jbake/content/code-conventions.ad
b/src/main/jbake/content/code-conventions.ad
index 323014df..5de51808 100644
--- a/src/main/jbake/content/code-conventions.ad
+++ b/src/main/jbake/content/code-conventions.ad
@@ -29,6 +29,7 @@ is contributed to the project should adhere to these
guidelines.
* Use _2_ spaces for indentation. _No_ tabs!
* Place open braces on the same line as the declaration, for example:
++
[source,java]
----
public class Foo extends Bar {
@@ -36,7 +37,7 @@ public class Foo extends Bar {
try {
for (int i = 0; i < args.length; i++) {
System.out.println(Integer.parseInt(args[i]));
- }
+ }
}
catch(NumberFormatException e) {
e.printStackTrace();
@@ -54,10 +55,11 @@ public class Foo extends Bar {
* Methods
* Do _not_ use package imports, for example:
- ** `import org.apache.opennlp.*`
++
+`import org.apache.opennlp.*`
* For other cases, we try to follow
-
https://www.oracle.com/java/technologies/cc-java-programming-language.html[Java
code conventions] as much as possible.
+
https://www.oracle.com/java/technologies/cc-java-programming-language.html[Java
code conventions,window=_blank] as much as possible.
## Formatter and Style files
-* A code formatter file for Eclipse can be found
link:code-formatter/OpenNLP-Eclipse-Formatter.xml[here] and the import order
file link:code-formatter/eclipse-opennlp.importorder[here].
-* A code formatter file for IntelliJ can be found
link:code-formatter/OpenNLP-IntelliJ-Formatter.xml[here].
+* A code formatter file for Eclipse can be found
link:code-formatter/OpenNLP-Eclipse-Formatter.xml[here,window=read-later] and
the import order file
link:code-formatter/eclipse-opennlp.importorder[here,window=read-later].
+* A code formatter file for IntelliJ can be found
link:code-formatter/OpenNLP-IntelliJ-Formatter.xml[here,window=read-later].
diff --git a/src/main/jbake/content/docs/index.ad
b/src/main/jbake/content/docs/index.ad
index 71cf86c8..7e1a5594 100755
--- a/src/main/jbake/content/docs/index.ad
+++ b/src/main/jbake/content/docs/index.ad
@@ -25,7 +25,7 @@
There exists a manual and Javadoc API documentation for Apache OpenNLP. The
manual
explains how the various OpenNLP components can be used and trained.
-### Apache OpenNLP {opennlp_version} documentation
+== Apache OpenNLP {opennlp_version} documentation
* link:/docs/{opennlp_version}/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/{opennlp_version}/apidocs/opennlp-tools/index.html[Apache OpenNLP
Tools Javadoc]
diff --git a/src/main/jbake/content/docs/legacy.ad
b/src/main/jbake/content/docs/legacy.ad
index 3d6914c6..b6eb135f 100755
--- a/src/main/jbake/content/docs/legacy.ad
+++ b/src/main/jbake/content/docs/legacy.ad
@@ -27,56 +27,56 @@ WARNING: This page contains the archived documentation.
Please refer to link:/do
There exists a manual and Javadoc API documentation for Apache OpenNLP. The
manual
explains how the various OpenNLP components can be used and trained.
-### Apache OpenNLP 2.1.1 documentation
+== Apache OpenNLP 2.1.1 documentation
* link:/docs/2.1.1/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/2.1.1/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools
Javadoc]
* link:/docs/2.1.1/apidocs/opennlp-uima/index.html[Apache OpenNLP UIMA Javadoc]
* link:/docs/2.1.1/apidocs/opennlp-brat-annotator/index.html[Apache OpenNLP
BRAT Annotator Javadoc]
* link:/docs/2.1.1/apidocs/opennlp-morfologik-addon/index.html[Apache OpenNLP
Morfologik Addon Javadoc]
-### Apache OpenNLP 2.1.0 documentation
+== Apache OpenNLP 2.1.0 documentation
* link:/docs/2.1.0/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/2.1.0/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools
Javadoc]
* link:/docs/2.1.0/apidocs/opennlp-uima/index.html[Apache OpenNLP UIMA Javadoc]
* link:/docs/2.1.0/apidocs/opennlp-brat-annotator/index.html[Apache OpenNLP
BRAT Annotator Javadoc]
* link:/docs/2.1.0/apidocs/opennlp-morfologik-addon/index.html[Apache OpenNLP
Morfologik Addon Javadoc]
-### Apache OpenNLP 2.0.0 documentation
+== Apache OpenNLP 2.0.0 documentation
* link:/docs/2.0.0/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/2.0.0/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools
Javadoc]
* link:/docs/2.0.0/apidocs/opennlp-uima/index.html[Apache OpenNLP UIMA Javadoc]
* link:/docs/2.0.0/apidocs/opennlp-brat-annotator/index.html[Apache OpenNLP
BRAT Annotator Javadoc]
* link:/docs/2.0.0/apidocs/opennlp-morfologik-addon/index.html[Apache OpenNLP
Morfologik Addon Javadoc]
-### Apache OpenNLP 1.9.4 documentation
+== Apache OpenNLP 1.9.4 documentation
* link:/docs/1.9.4/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/1.9.4/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools
Javadoc]
* link:/docs/1.9.4/apidocs/opennlp-uima/index.html[Apache OpenNLP UIMA Javadoc]
* link:/docs/1.9.4/apidocs/opennlp-brat-annotator/index.html[Apache OpenNLP
BRAT Annotator Javadoc]
* link:/docs/1.9.4/apidocs/opennlp-morfologik-addon/index.html[Apache OpenNLP
Morfologik Addon Javadoc]
-### Apache OpenNLP 1.9.3 documentation
+== Apache OpenNLP 1.9.3 documentation
* link:/docs/1.9.3/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/1.9.3/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools
Javadoc]
* link:/docs/1.9.3/apidocs/opennlp-uima/index.html[Apache OpenNLP UIMA Javadoc]
* link:/docs/1.9.3/apidocs/opennlp-brat-annotator/index.html[Apache OpenNLP
BRAT Annotator Javadoc]
* link:/docs/1.9.3/apidocs/opennlp-morfologik-addon/index.html[Apache OpenNLP
Morfologik Addon Javadoc]
-### Apache OpenNLP 1.9.2 documentation
+== Apache OpenNLP 1.9.2 documentation
* link:/docs/1.9.2/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/1.9.2/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools
Javadoc]
* link:/docs/1.9.2/apidocs/opennlp-uima/index.html[Apache OpenNLP UIMA Javadoc]
* link:/docs/1.9.2/apidocs/opennlp-brat-annotator/index.html[Apache OpenNLP
BRAT Annotator Javadoc]
* link:/docs/1.9.2/apidocs/opennlp-morfologik-addon/index.html[Apache OpenNLP
Morfologik Addon Javadoc]
-### Apache OpenNLP 1.9.1 documentation
+== Apache OpenNLP 1.9.1 documentation
* link:/docs/1.9.1/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/1.9.1/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools
Javadoc]
* link:/docs/1.9.1/apidocs/opennlp-uima/index.html[Apache OpenNLP UIMA Javadoc]
* link:/docs/1.9.1/apidocs/opennlp-brat-annotator/index.html[Apache OpenNLP
BRAT Annotator Javadoc]
* link:/docs/1.9.1/apidocs/opennlp-morfologik-addon/index.html[Apache OpenNLP
Morfologik Addon Javadoc]
-### Apache OpenNLP 1.9.0 documentation
+== Apache OpenNLP 1.9.0 documentation
* link:/docs/1.9.0/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/1.9.0/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools
Javadoc]
@@ -84,7 +84,7 @@ explains how the various OpenNLP components can be used and
trained.
* link:/docs/1.9.0/apidocs/opennlp-brat-annotator/index.html[Apache OpenNLP
BRAT Annotator Javadoc]
* link:/docs/1.9.0/apidocs/opennlp-morfologik-addon/index.html[Apache OpenNLP
Morfologik Addon Javadoc]
-### Apache OpenNLP 1.8.4 documentation
+== Apache OpenNLP 1.8.4 documentation
* link:/docs/1.8.4/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/1.8.4/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools
Javadoc]
@@ -92,7 +92,7 @@ explains how the various OpenNLP components can be used and
trained.
* link:/docs/1.8.4/apidocs/opennlp-brat-annotator/index.html[Apache OpenNLP
BRAT Annotator Javadoc]
* link:/docs/1.8.4/apidocs/opennlp-morfologik-addon/index.html[Apache OpenNLP
Morfologik Addon Javadoc]
-### Apache OpenNLP 1.8.3 documentation
+== Apache OpenNLP 1.8.3 documentation
* link:/docs/1.8.3/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/1.8.3/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools
Javadoc]
@@ -100,7 +100,7 @@ explains how the various OpenNLP components can be used and
trained.
* link:/docs/1.8.3/apidocs/opennlp-brat-annotator/index.html[Apache OpenNLP
BRAT Annotator Javadoc]
* link:/docs/1.8.3/apidocs/opennlp-morfologik-addon/index.html[Apache OpenNLP
Morfologik Addon Javadoc]
-### Apache OpenNLP 1.8.2 documentation
+== Apache OpenNLP 1.8.2 documentation
* link:/docs/1.8.2/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/1.8.2/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools
Javadoc]
@@ -108,7 +108,7 @@ explains how the various OpenNLP components can be used and
trained.
* link:/docs/1.8.2/apidocs/opennlp-brat-annotator/index.html[Apache OpenNLP
BRAT Annotator Javadoc]
* link:/docs/1.8.2/apidocs/opennlp-morfologik-addon/index.html[Apache OpenNLP
Morfologik Addon Javadoc]
-### Apache OpenNLP 1.8.1 documentation
+== Apache OpenNLP 1.8.1 documentation
* link:/docs/1.8.1/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/1.8.1/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools
Javadoc]
@@ -116,7 +116,7 @@ explains how the various OpenNLP components can be used and
trained.
* link:/docs/1.8.1/apidocs/opennlp-brat-annotator/index.html[Apache OpenNLP
BRAT Annotator Javadoc]
* link:/docs/1.8.1/apidocs/opennlp-morfologik-addon/index.html[Apache OpenNLP
Morfologik Addon Javadoc]
-### Apache OpenNLP 1.8.0 documentation
+== Apache OpenNLP 1.8.0 documentation
* link:/docs/1.8.0/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/1.8.0/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools
Javadoc]
@@ -124,7 +124,7 @@ explains how the various OpenNLP components can be used and
trained.
* link:/docs/1.8.0/apidocs/opennlp-brat-annotator/index.html[Apache OpenNLP
BRAT Annotator Javadoc]
* link:/docs/1.8.0/apidocs/opennlp-morfologik-addon/index.html[Apache OpenNLP
Morfologik Addon Javadoc]
-### Apache OpenNLP 1.7.2 documentation
+== Apache OpenNLP 1.7.2 documentation
* link:/docs/1.7.2/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/1.7.2/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools
Javadoc]
@@ -132,7 +132,7 @@ explains how the various OpenNLP components can be used and
trained.
* link:/docs/1.7.2/apidocs/opennlp-brat-annotator/index.html[Apache OpenNLP
BRAT Annotator Javadoc]
* link:/docs/1.7.2/apidocs/opennlp-morfologik-addon/index.html[Apache OpenNLP
Morfologik Addon Javadoc]
-### Apache OpenNLP 1.7.1 documentation
+== Apache OpenNLP 1.7.1 documentation
* link:/docs/1.7.1/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/1.7.1/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools
Javadoc]
@@ -140,7 +140,7 @@ explains how the various OpenNLP components can be used and
trained.
* link:/docs/1.7.1/apidocs/opennlp-brat-annotator/index.html[Apache OpenNLP
BRAT Annotator Javadoc]
* link:/docs/1.7.1/apidocs/opennlp-morfologik-addon/index.html[Apache OpenNLP
Morfologik Addon Javadoc]
-### Apache OpenNLP 1.7.0 documentation
+== Apache OpenNLP 1.7.0 documentation
* link:/docs/1.7.0/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/1.7.0/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools
Javadoc]
@@ -148,13 +148,13 @@ explains how the various OpenNLP components can be used
and trained.
* link:/docs/1.7.0/apidocs/opennlp-brat-annotator/index.html[Apache OpenNLP
BRAT Annotator Javadoc]
* link:/docs/1.7.0/apidocs/opennlp-morfologik-addon/index.html[Apache OpenNLP
Morfologik Addon Javadoc]
-### Apache OpenNLP 1.6.0 documentation
+== Apache OpenNLP 1.6.0 documentation
* link:/docs/1.6.0/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/1.6.0/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools
Javadoc]
* link:/docs/1.6.0/apidocs/opennlp-uima/index.html[Apache OpenNLP UIMA Javadoc]
-### Apache OpenNLP 1.5.3 documentation
+== Apache OpenNLP 1.5.3 documentation
* link:/docs/1.5.3/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/1.5.3/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools
Javadoc]
diff --git a/src/main/jbake/content/get-involved.ad
b/src/main/jbake/content/get-involved.ad
index 825a9ee4..7257f3fd 100644
--- a/src/main/jbake/content/get-involved.ad
+++ b/src/main/jbake/content/get-involved.ad
@@ -61,17 +61,17 @@ issues please post them to the JIRA pages and not to this
list. This list is mai
## Making a Contribution
-* Create a new issue in the
https://issues.apache.org/jira/browse/OPENNLP[Apache OpenNLP JIRA]. Please
describe the problem or improvement in the body of the issue. For larger
issues, please first contact the developer mailing list and describe the
problem.
-* Next, create a pull request in
https://github.com/apache/opennlp/pulls[GitHub].
+* Create a new issue in the Apache OpenNLP
https://issues.apache.org/jira/browse/OPENNLP[JIRA,window=_blank]. Please
describe the problem or improvement in the body of the issue. For larger
issues, please first contact the developer mailing list and describe the
problem.
+* Next, create a pull request in
https://github.com/apache/opennlp/pulls[GitHub,window=_blank].
Bigger contributions can eventually only be accepted when an
-https://www.apache.org/licenses/icla.txt[ICLA],
https://www.apache.org/licenses/cla-corporate.txt[CCLA]
-or https://www.apache.org/licenses/software-grant.txt[software grant] is on
file.
+https://apache.org/licenses/icla.pdf[ICLA,window=_blank],
https://www.apache.org/licenses/cla-corporate.txt[CCLA,window=_blank]
+or https://www.apache.org/licenses/software-grant.txt[software
grant,window=_blank] is on file.
Contributors who have a history of successful participation are invited to join
the project as a committer from the
https://incubator.apache.org/guides/ppmc.html[PPMC].
## Open Tasks
-Please see the Apache OpenNLP
https://issues.apache.org/jira/browse/OPENNLP[JIRA] for a list of tasks. If you
would like to work on a task, please email the developers mailing list and
request to do so. You will then be assigned the issue in JIRA.
+Please see the Apache OpenNLP
https://issues.apache.org/jira/browse/OPENNLP[JIRA,window=_blank] for a list of
tasks. If you would like to work on a task, please email the developers mailing
list and request to do so. You will then be assigned the issue in JIRA.
diff --git a/src/main/jbake/content/mailing-lists.ad
b/src/main/jbake/content/mailing-lists.ad
index 75ef849b..6e324d88 100644
--- a/src/main/jbake/content/mailing-lists.ad
+++ b/src/main/jbake/content/mailing-lists.ad
@@ -46,7 +46,7 @@ to the issue tracker for the project.
|link:++https://lists.apache.org/[email protected]++[Archives]
|Issues Mailing List
-|This list follows changes and posts to JIRA, the projects bug tracking
system. If you have any
+|This list follows changes and posts to
https://issues.apache.org/jira/browse/OPENNLP[JIRA], the projects bug tracking
system. If you have any
issues please post them to the JIRA pages and not to this list. This list is
mainly for developers to keep track of changes and issues to be resolved;
however, any changes should be posted to the JIRA pages and _not_ _directly_ to
this mailing list.
|mailto:[email protected][Subscribe]
|mailto:[email protected][Unsubscribe]
diff --git a/src/main/jbake/content/maven-dependency.ad
b/src/main/jbake/content/maven-dependency.ad
index ec2328ce..1e4aa923 100755
--- a/src/main/jbake/content/maven-dependency.ad
+++ b/src/main/jbake/content/maven-dependency.ad
@@ -24,10 +24,8 @@
Apache OpenNLP is also distributed via the Maven Central Repository and
the maven artifacts are located
https://repo1.maven.org/maven2/org/apache/opennlp/[here].
-
The Apache OpenNLP project publishes the library, javadoc and source code jars.
-
-To use OpenNLP in your project specify exactly one of the following
dependencies,
+To use OpenNLP in your project, specify exactly one of the following
dependencies,
all transient dependencies are resolved automatically.
## OpenNLP Tools Dependency
diff --git a/src/main/jbake/content/news/release-170.ad
b/src/main/jbake/content/news/release-170.ad
index 0ba67669..c7a212e3 100644
--- a/src/main/jbake/content/news/release-170.ad
+++ b/src/main/jbake/content/news/release-170.ad
@@ -35,6 +35,8 @@ The OpenNLP 1.7.0 binary and source distributions are
available for download fro
The OpenNLP library is distributed by Maven Central as well. See the Maven
Dependency page for more details:
<https://opennlp.apache.org/maven-dependency.html>
+== What is new in Apache OpenNLP 1.7.0
+
This release introduces many new features, improvements and bug fixes. The API
has been improved for a better consistency and deprecated methods were removed.
Now Java 1.8 and Maven 3.3.9 are required.
Additionally, the release contains the following noteworthy changes:
@@ -45,12 +47,11 @@ Additionally, the release contains the following noteworthy
changes:
- There is a new brat annotation service
- Documentation was improved and extended
- A Naive Bayesian Classifier implementation was added
-- Morofologik addon is now included
+- Morfologik addon is now included
- Added a language model component
- Added a CLI to the lemmatizer component.
- Added a supervised statistical lemmatizer.
-- The lemmatizer component API has been entirely rewritten. The changes in
- the previously existing Dictionary-based lemmatizer are not backward
compatible.
+- The lemmatizer component API has been entirely rewritten. The changes in the
previously existing Dictionary-based lemmatizer are not backward compatible.
A detailed list of the issues related to this release can be found in the
release
notes.
diff --git a/src/main/jbake/content/news/release-171.ad
b/src/main/jbake/content/news/release-171.ad
index 2bbee82b..10914169 100644
--- a/src/main/jbake/content/news/release-171.ad
+++ b/src/main/jbake/content/news/release-171.ad
@@ -37,8 +37,8 @@ The OpenNLP library is distributed by Maven Central as well.
See the Maven Depen
== Requirements
-Java 1.8 is required to run OpenNLP
-Maven 3.3.9 is required for building it
+Java 1.8 is required to run OpenNLP.
+Maven 3.3.9 is required for building it.
== Building from the Source Distribution
@@ -46,15 +46,15 @@ To build everything execute the following command in the
root folder:
mvn clean install
-The results of the build will be placed in:
- opennlp-distr/target/apache-opennlp-1.7.1-bin.tar-gz (or .zip)
+The results of the build will be placed in:
+_opennlp-distr/target/apache-opennlp-1.7.1-bin.tar.gz_
+(or _.zip_)
-What is new in Apache OpenNLP 1.7.1
----------------------------------------
+== What is new in Apache OpenNLP 1.7.1
This release introduces many new features, improvements and bug fixes.
-Additionally the release contains the following noteworthy changes:
+Additionally, the release contains the following noteworthy changes:
- Travis CI Integration
- Added support to LETSMT format
diff --git a/src/main/jbake/content/news/release-172.ad
b/src/main/jbake/content/news/release-172.ad
index 7c940c0f..91092823 100644
--- a/src/main/jbake/content/news/release-172.ad
+++ b/src/main/jbake/content/news/release-172.ad
@@ -47,14 +47,13 @@ To build everything execute the following command in the
root folder:
The results of the build will be placed in:
opennlp-distr/target/apache-opennlp-1.7.2-bin.tar-gz (or .zip)
-What is new in Apache OpenNLP 1.7.2
----------------------------------------
+== What is new in Apache OpenNLP 1.7.2
This release introduces many new features, improvements and bug fixes. The API
has been improved for a better consistency and 1.4 deprecated methods were
removed. Now Java 1.8 is required.
-Additionally the release contains the following noteworthy changes:
+Additionally, the release contains the following noteworthy changes:
- Name Finder evaluation can now show a confusion matrix
- The default evaluation output contains more details
diff --git a/src/main/jbake/content/news/release-180.ad
b/src/main/jbake/content/news/release-180.ad
index c03ae824..38c985a5 100644
--- a/src/main/jbake/content/news/release-180.ad
+++ b/src/main/jbake/content/news/release-180.ad
@@ -41,11 +41,11 @@ To build everything execute the following command in the
root folder: `mvn clean
The results of the build will be placed in:
`opennlp-distr/target/apache-opennlp-1.8.0-bin.tar.gz` (or `.zip`)
-# What's new in Apache OpenNLP 1.8.0
+== What's new in Apache OpenNLP 1.8.0
This release introduces many new features, improvements and bug fixes. The API
has been improved for a better consistency and many deprecated methods were
removed. Java 1.8 is required.
-Additionally the release contains the following noteworthy changes:
+Additionally, the release contains the following noteworthy changes:
- POS Tagger context generator now supports feature generation XML
- Add a Name Finder feature generator that adds POS Tag features
diff --git a/src/main/jbake/content/news/release-181.ad
b/src/main/jbake/content/news/release-181.ad
index 3ec646f6..cc2385f5 100644
--- a/src/main/jbake/content/news/release-181.ad
+++ b/src/main/jbake/content/news/release-181.ad
@@ -41,11 +41,11 @@ To build everything execute the following command in the
root folder: `mvn clean
The results of the build will be placed in:
`opennlp-distr/target/apache-opennlp-1.8.1-bin.tar.gz` (or `.zip`)
-# What's new in Apache OpenNLP 1.8.1
+== What's new in Apache OpenNLP 1.8.1
This release introduces many new features, improvements and bug fixes. The API
has been improved for a better consistency and many deprecated methods were
removed. Java 1.8 is required.
-Additionally the release contains the following noteworthy changes:
+Additionally, the release contains the following noteworthy changes:
- A new Language Detection Component
- Support for Irish Sentence Bank formats
diff --git a/src/main/jbake/content/news/release-182.ad
b/src/main/jbake/content/news/release-182.ad
index bb780597..9de493b7 100644
--- a/src/main/jbake/content/news/release-182.ad
+++ b/src/main/jbake/content/news/release-182.ad
@@ -41,7 +41,7 @@ To build everything execute the following command in the root
folder: `mvn clean
The results of the build will be placed in:
`opennlp-distr/target/apache-opennlp-1.8.2-bin.tar.gz` (or `.zip`)
-# What's new in Apache OpenNLP 1.8.2
+== What's new in Apache OpenNLP 1.8.2
This release introduces some minor improvements and bug fixes. Java 1.8 is
required.
diff --git a/src/main/jbake/content/news/release-183.ad
b/src/main/jbake/content/news/release-183.ad
index 49bb7f1d..0a1f4a31 100644
--- a/src/main/jbake/content/news/release-183.ad
+++ b/src/main/jbake/content/news/release-183.ad
@@ -36,11 +36,11 @@ Apache OpenNLP 1.8.3 binary and source distributions are
available for download
The OpenNLP library is distributed by Maven Central as well. See the Maven
Dependency page for more details: link:/maven-dependency.html[Maven Dependency]
-# What's new in Apache OpenNLP 1.8.3
+== What's new in Apache OpenNLP 1.8.3
This release introduces new features, improvements and bug fixes. Java 1.8 and
Maven 3.3.9 are required.
-Additionally the release contains the following noteworthy changes:
+Additionally, the release contains the following noteworthy changes:
- New experimental API for Word Vectors and support for Glove vector files
- Code cleanups and addition of test cases
- Java 9 module name is now set to org.apache.opennlp.tools
diff --git a/src/main/jbake/content/news/release-184.ad
b/src/main/jbake/content/news/release-184.ad
index b767b416..ebabb5d2 100644
--- a/src/main/jbake/content/news/release-184.ad
+++ b/src/main/jbake/content/news/release-184.ad
@@ -35,11 +35,11 @@ Apache OpenNLP 1.8.4 binary and source distributions are
available for download
The OpenNLP library is distributed by Maven Central as well. See the Maven
Dependency page for more details: link:/maven-dependency.html[Maven Dependency]
-# What's new in Apache OpenNLP 1.8.4
+== What's new in Apache OpenNLP 1.8.4
This release introduces new features, improvements and bug fixes. Java 1.8 and
Maven 3.3.9 are required.
-Additionally the release contains the following changes:
+Additionally, the release contains the following changes:
- Remove Tokenizer param from Doccat trainer CLI
- Add annotator notes to BratAnnotator
diff --git a/src/main/jbake/content/news/release-190.ad
b/src/main/jbake/content/news/release-190.ad
index 69a134dc..26be09a5 100644
--- a/src/main/jbake/content/news/release-190.ad
+++ b/src/main/jbake/content/news/release-190.ad
@@ -35,11 +35,11 @@ Apache OpenNLP 1.9.0 binary and source distributions are
available for download
The OpenNLP library is distributed by Maven Central as well. See the Maven
Dependency page for more details: link:/maven-dependency.html[Maven Dependency]
-# What's new in Apache OpenNLP 1.9.0
+== What's new in Apache OpenNLP 1.9.0
This release introduces new features, improvements and bug fixes. Java 1.8 and
Maven 3.3.9 are required.
-Additionally the release contains the following changes:
+Additionally, the release contains the following changes:
- Brat Document Parser should support name type filters
- Brat format support fails on multi fragment annotations
diff --git a/src/main/jbake/content/news/release-191.ad
b/src/main/jbake/content/news/release-191.ad
index 6552ab59..9e827de9 100644
--- a/src/main/jbake/content/news/release-191.ad
+++ b/src/main/jbake/content/news/release-191.ad
@@ -35,7 +35,7 @@ Apache OpenNLP 1.9.1 binary and source distributions are
available for download
The OpenNLP library is distributed by Maven Central as well. See the Maven
Dependency page for more details: link:/maven-dependency.html[Maven Dependency]
-# What's new in Apache OpenNLP 1.9.1
+== What's new in Apache OpenNLP 1.9.1
- Add TrigramNameFeatureGeneratorFactory
- Documentation updates.
diff --git a/src/main/jbake/content/news/release-192.ad
b/src/main/jbake/content/news/release-192.ad
index 134cff09..a8479536 100644
--- a/src/main/jbake/content/news/release-192.ad
+++ b/src/main/jbake/content/news/release-192.ad
@@ -35,7 +35,7 @@ Apache OpenNLP 1.9.2 binary and source distributions are
available for download
The OpenNLP library is distributed by Maven Central as well. See the Maven
Dependency page for more details: link:/maven-dependency.html[Maven Dependency]
-# What's new in Apache OpenNLP 1.9.2
+== What's new in Apache OpenNLP 1.9.2
- Add SHA-512 checksum files for artifacts.
- LanguageDetectorEvaluatorTest failure in Windows.
diff --git a/src/main/jbake/content/news/release-193.ad
b/src/main/jbake/content/news/release-193.ad
index ab4e451f..30ec2877 100644
--- a/src/main/jbake/content/news/release-193.ad
+++ b/src/main/jbake/content/news/release-193.ad
@@ -35,7 +35,7 @@ Apache OpenNLP 1.9.3 binary and source distributions are
available for download
The OpenNLP library is distributed by Maven Central as well. See the Maven
Dependency page for more details: link:/maven-dependency.html[Maven Dependency]
-# What's new in Apache OpenNLP 1.9.3
+== What's new in Apache OpenNLP 1.9.3
- Resolved issues building on Java 11.
- Using strict math for calculations for consistent evaluations.
diff --git a/src/main/jbake/content/news/release-194.ad
b/src/main/jbake/content/news/release-194.ad
index 704bf938..cf83eaaf 100644
--- a/src/main/jbake/content/news/release-194.ad
+++ b/src/main/jbake/content/news/release-194.ad
@@ -35,7 +35,7 @@ Apache OpenNLP 1.9.4 binary and source distributions are
available for download
The OpenNLP library is distributed by Maven Central as well. See the Maven
Dependency page for more details: link:/maven-dependency.html[Maven Dependency]
-# What's new in Apache OpenNLP 1.9.4
+== What's new in Apache OpenNLP 1.9.4
- Refactorings to improve code quality and performance.
- Fix Parser top k parses doesn't show "top" (highest probability) parses.
diff --git a/src/main/jbake/content/news/release-200.ad
b/src/main/jbake/content/news/release-200.ad
index 9c031305..1a181c8d 100644
--- a/src/main/jbake/content/news/release-200.ad
+++ b/src/main/jbake/content/news/release-200.ad
@@ -35,7 +35,7 @@ Apache OpenNLP 2.0.0 binary and source distributions are
available for download
The OpenNLP library is distributed by Maven Central as well. See the Maven
Dependency page for more details: link:/maven-dependency.html[Maven Dependency]
-# What's new in Apache OpenNLP 2.0.0
+== What's new in Apache OpenNLP 2.0.0
- Adds ability to download models from within Apache OpenNLP
- Now builds using Java 11
@@ -49,6 +49,6 @@ The OpenNLP library is distributed by Maven Central as well.
See the Maven Depen
A detailed list of the issues related to this release can be found in the
release notes.
-For a complete list of fixed bugs and improvements please see the README.html
file included in the distribution.
+For a complete list of fixed bugs and improvements please see the
_README.html_ file included in the distribution.
--The Apache OpenNLP Team
diff --git a/src/main/jbake/content/news/release-210.ad
b/src/main/jbake/content/news/release-210.ad
index d53bbd20..a7abc78e 100644
--- a/src/main/jbake/content/news/release-210.ad
+++ b/src/main/jbake/content/news/release-210.ad
@@ -35,7 +35,7 @@ Apache OpenNLP 2.1.0 binary and source distributions are
available for download
The OpenNLP library is distributed by Maven Central as well. See the Maven
Dependency page for more details: link:/maven-dependency.html[Maven Dependency]
-# What's new in Apache OpenNLP 2.1.0
+== What's new in Apache OpenNLP 2.1.0
- Update language codes in documentation
- Enable optional GPU inference in ONNX Runtime configuration
diff --git a/src/main/jbake/content/news/release-211.ad
b/src/main/jbake/content/news/release-211.ad
index b3030789..860f20dd 100644
--- a/src/main/jbake/content/news/release-211.ad
+++ b/src/main/jbake/content/news/release-211.ad
@@ -35,7 +35,7 @@ Apache OpenNLP 2.1.1 binary and source distributions are
available for download
The OpenNLP library is distributed by Maven Central as well. See the Maven
Dependency page for more details: link:/maven-dependency.html[Maven Dependency]
-# What's new in Apache OpenNLP 2.1.1
+== What's new in Apache OpenNLP 2.1.1
This version contains improvements to unit tests, code quality, JavaDocs, and
a few minor fixes.
diff --git a/src/main/jbake/content/news/release-220.ad
b/src/main/jbake/content/news/release-220.ad
index 208c837b..afabbf44 100644
--- a/src/main/jbake/content/news/release-220.ad
+++ b/src/main/jbake/content/news/release-220.ad
@@ -35,7 +35,7 @@ Apache OpenNLP 2.2.0 binary and source distributions are
available for download
The OpenNLP library is distributed by Maven Central as well. See the Maven
Dependency page for more details: link:/maven-dependency.html[Maven Dependency]
-# What's new in Apache OpenNLP 2.2.0
+== What's new in Apache OpenNLP 2.2.0
This version contains improvements to logging by introducing SLF4J to replace
logging using System.out. ONNX Runtime support for sentence-transformers was
also introduced. This version also includes fixes for stemming, documentation,
and unit tests.
diff --git a/src/main/jbake/content/release-model.ad
b/src/main/jbake/content/release-model.ad
index a29f38fa..26e8f698 100644
--- a/src/main/jbake/content/release-model.ad
+++ b/src/main/jbake/content/release-model.ad
@@ -25,14 +25,15 @@
## Release Preparation
- Elect a release manager.
-- Create a ticket for a new model release in JIRA. If you do not have
permission to do so just ask to be given permissions on the mailing list.
+- Create a ticket for a new model release in
https://issues.apache.org/jira/browse/OPENNLP[JIRA,window=_blank]. If you do
not have permission to do so just ask to be given permissions on the mailing
list.
## Steps for the Release Manager
The following steps need only to be performed once.
-- Make sure you have your PGP key added to
https://dist.apache.org/repos/dist/release/opennlp/KEYS via SVN
+- Make sure you have your PGP key added to
https://dist.apache.org/repos/dist/release/opennlp/KEYS[window=_blank] via SVN
If the key isn't contained in this file, add your PGP key to the KEYS file:
++
----
Examples of adding your key to this file:
pgp -kxa <your name> and append it to this file.
@@ -41,6 +42,7 @@ Examples of adding your key to this file:
&& gpg --armor --export <your name>) >> this file.
----
- In a local temp folder, svn checkout the OpenNLP artifacts and update the
KEYS file
++
----
svn co https://dist.apache.org/repos/dist/release/opennlp/
svn commit -m "Added Key for <name>" KEYS
@@ -59,15 +61,14 @@ svn commit -m "Added Key for <name>" KEYS
#### Perform the Model Release
- Create sha512 checksums
-
++
----
# cd to model location
for f in *; do sha512sum "$f" > "$f.sha512"; done
----
-
-- Create PGP signatures, see https://infra.apache.org/release-signing.html[for
details].
+- Create PGP signatures, see https://infra.apache.org/release-signing.html[for
details,window=_blank].
If you have multiple keys on your system, you might need to use `-u` to select
the signing key.
-
++
----
# cd to model location
# create asc signatures for model files
@@ -80,11 +81,9 @@ for f in *.zip; do
gpg --armor --output $f.asc --detach-sig $f
done
----
-
- Add README, NOTICE, LICENSE and CHANGES (if any)
-
- Create a folder in `dist/dev/models` in SVN
-
++
----
svn co https://dist.apache.org/repos/dist/dev/opennlp/ dist-dev
# check if the KEYS file contains your key, if not, update it
@@ -98,13 +97,13 @@ Make sure to adhere to the model naming conventions.
#### Model Naming Conventions
-- The filenames of each model signify the model language, type,
https://universaldependencies.org/[Universal Dependency training data used],
and version numbers.
+- The filenames of each model signify the model language, type,
https://universaldependencies.org/[Universal Dependency training
data,window=_blank] used, and version numbers.
- The filename format is
`opennlp-[iso-language-code]-ud-[corpus]-[model-type]-[model-version]-[opennlp-version-used-for-training].bin`.
- The evaluation logs must be zipped and adhere to the following format:
`opennlp-training-eval-logs-[model-version]-[opennlp-version-used-for-training].zip`.
It contains the evaluation logs for trained models.
- For example, the model file `opennlp-de-ud-gsd-pos-1.0-1.9.3` is German
language, trained on the UD GSD corpus, and is a parts-of-speech model. It is
version 1.0 of the model, and it was trained using OpenNLP 1.9.3.
-**Note:** If other training data is used, the abbreviation `ud` needs to be
adjusted!
+NOTE: If other training data is used, the abbreviation `ud` needs to be
adjusted!
#### Check the Model Release Artifacts
@@ -116,9 +115,9 @@ Perform basic checks against the release binary:
#### Create a VOTE Thread
- Notify the developer mailing list of a new model vote. Be sure to replace
all values in `[]` with the appropriate values.
-
-Message Subject: [VOTE] Apache OpenNLP Models [version] Release Candidate
-
++
+_Message Subject: [VOTE] Apache OpenNLP Models [version] Release Candidate_
++
----
Hi folks,
@@ -147,7 +146,7 @@ Thanks!
## After a Successful Vote
-The vote is successful if at least 3 +1 votes are received from OpenNLP PMC
members after a minimum of 72 hours of sending the vote email.
+The vote is successful if at least 3 _+1_ votes are received from OpenNLP PMC
members after a minimum of 72 hours of sending the vote email.
Acknowledge the voting results on the mailing list in the VOTE thread.
### Commit Distribution to SVN
@@ -169,12 +168,12 @@ Remove the old model release from SVN under
https://dist.apache.org/repos/dist/r
### Update the Website
-Update the https://opennlp.apache.org/models.html[website] once the new
version appears in the Apache download mirrors (keep checking
https://www.apache.org/dyn/closer.cgi/opennlp/models/ until you see something).
+Update the https://opennlp.apache.org/models.html[website,window=_blank] once
the new version appears in the Apache download mirrors (keep checking
https://www.apache.org/dyn/closer.cgi/opennlp/models/[window=_blank] until you
see something).
#### Add News Item
- Add a news item in `news/model-{model-type}-{xyz}.ad` by copying the
adjusted content:
-
++
----
= <MODEL_TYPE> Models for Apache OpenNLP released
Apache OpenNLP
@@ -212,19 +211,19 @@
https://dist.apache.org/repos/dist/dev/opennlp/<MODEL_TYPE>-<MODEL_VERSION>/open
### Post-Release Steps
-- Log the new version at https://reporter.apache.org/addrelease.html?opennlp.
+- Log the new version at
https://reporter.apache.org/addrelease.html?opennlp[window=_blank].
- Announce the new models on the OpenNLP Twitter.
-- Announce the new models on the Apache OpenNLP blog at
https://blogs.apache.org/opennlp/.
-- Close the present release ticket in JIRA.
+- Close the present release ticket in
https://issues.apache.org/jira/browse/OPENNLP[JIRA,window=_blank].
- Send announcement email to [email protected], [email protected],
[email protected].
This needs to be done from your @apache.org email address or the email will
bounce from the announce list.
++
----
Title: [ANNOUNCE] OpenNLP Models <version> released
TO: [email protected], [email protected], [email protected]
----
-
++
Message body:
-
++
----
The Apache OpenNLP library is a machine learning based toolkit for the
processing of natural language text.
diff --git a/src/main/jbake/content/release.ad
b/src/main/jbake/content/release.ad
index a380a1d0..d6dbba8c 100644
--- a/src/main/jbake/content/release.ad
+++ b/src/main/jbake/content/release.ad
@@ -25,8 +25,8 @@
## Release Preparation
- Elect a release manager.
-- Create a ticket for a new release in JIRA. If you do not have permission to
do so just ask to be given permissions on the mailing list.
-- Review all of the JIRA issues associated with the release. All issues should
be resolved and closed.
+- Create a ticket for a new release in
https://issues.apache.org/jira/browse/OPENNLP[JIRA]. If you do not have
permission to do so just ask to be given permissions on the mailing list.
+- Review all of the https://issues.apache.org/jira/browse/OPENNLP[JIRA] issues
associated with the release. All issues should be resolved and closed.
- Any issues assigned to the release that are not complete should be assigned
to the next release. Any critical or blocker issues should be resolved on the
mailing list. Discuss any issues that you are unsure of on the mailing list.
## Steps for the Release Manager
@@ -37,6 +37,7 @@ The following steps need only to be performed once.
Your KEYS will then be present in
https://people.apache.org/keys/group/opennlp.asc.
- Make sure you have your PGP keys password.
- Add your PGP key to the KEYS file:
++
----
Examples of adding your key to this file:
pgp -kxa <your name> and append it to this file.
@@ -45,12 +46,13 @@ Examples of adding your key to this file:
&& gpg --armor --export <your name>) >> this file.
----
- In a local temp folder, svn checkout the OpenNLP artifacts and update the
KEYS file
++
----
svn co https://dist.apache.org/repos/dist/release/opennlp/
svn commit -m"Added Key for <name>" KEYS
----
- Create a maven `settings.xml` to publish to `repository.apache.org`. An
example configuration:
-
++
----
<server>
<id>apache.releases.https</id>
@@ -120,7 +122,7 @@ Thanks!
## After a Successful Vote
-The vote is successful if at least 3 +1 votes are received from OpenNLP PMC
members after a minimum of 72 hours of sending the vote email.
+The vote is successful if at least 3 _+1_ votes are received from OpenNLP PMC
members after a minimum of 72 hours of sending the vote email.
Acknowledge the voting results on the mailing list in the VOTE thread.
### Release Nexus Staging Repository
@@ -207,7 +209,7 @@ Move the last version's links to the documentation to the
Legacy Documentation (
- Log the new version at https://reporter.apache.org/addrelease.html?opennlp.
- Announce the new version on the OpenNLP Twitter.
- Announce the new version on the Apache OpenNLP blog at
https://blogs.apache.org/opennlp/.
-- Close the present release ticket in JIRA.
+- Close the present release ticket in
https://issues.apache.org/jira/browse/OPENNLP[JIRA].
- Send announcement email to [email protected], [email protected],
[email protected]. This needs to be done from your @apache.org email
address or the email will bounce from the announce list. Gmail forwarding can
help here and is a snap to set up
(https://gmailblog.blogspot.com/2009/07/send-mail-from-another-address-without.html).
It's even easier than the instructions there as it will recognize your email
address and default to Apache settings. It is important to include [...]
----
diff --git a/src/main/jbake/content/source-code.ad
b/src/main/jbake/content/source-code.ad
index e6e90a5b..6e12ac32 100644
--- a/src/main/jbake/content/source-code.ad
+++ b/src/main/jbake/content/source-code.ad
@@ -25,10 +25,10 @@
## GitHub Mirror Access
View the code, fork and send pull requests on Github:
-* https://github.com/apache/opennlp[Github opennlp]
-* https://github.com/apache/opennlp-site[Github opennlp-site]
-* https://github.com/apache/opennlp-addons[Github opennlp-addons]
-* https://github.com/apache/opennlp-sandbox[Github opennlp-sandbox]
+* https://github.com/apache/opennlp[Github opennlp,window=_blank]
+* https://github.com/apache/opennlp-site[Github opennlp-site,window=_blank]
+* https://github.com/apache/opennlp-addons[Github opennlp-addons,window=_blank]
+* https://github.com/apache/opennlp-sandbox[Github
opennlp-sandbox,window=_blank]
## Apache Git Repository
The Git repositories can be checked out with these commands:
diff --git a/src/main/jbake/content/using-git.ad
b/src/main/jbake/content/using-git.ad
index d726c214..0fe68f02 100644
--- a/src/main/jbake/content/using-git.ad
+++ b/src/main/jbake/content/using-git.ad
@@ -28,16 +28,16 @@ There are several ways to set up Git for committers and
contributors. Contributo
- Create a Github account or use an existing one
- Enable 2FA for the Github account, then logout and login
--
https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/[Configure
your ssh key]
-- Enter your Github username for your Apache account under
https://id.apache.org
-- Register here https://gitbox.apache.org/setup/
-- The gitbox setup will confirm that everything is working, to confirm again
check that you are listed as a member here:
https://github.com/orgs/apache/teams/opennlp-committers/members.
+-
https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/[Configure
your ssh key,window=_blank]
+- Enter your Github username for your Apache account under
https://id.apache.org[window=_blank]
+- Register here https://gitbox.apache.org/setup/[window=_blank]
+- The gitbox setup will confirm that everything is working, to confirm again
check that you are listed as a member here:
https://github.com/orgs/apache/teams/opennlp-committers/members[window=_blank].
- Fork the OpenNLP repositories:
- * https://github.com/apache/opennlp-sandbox
- * https://github.com/apache/opennlp-addons
- * https://github.com/apache/opennlp-site
- * https://github.com/apache/opennlp
-- Configure your
https://help.github.com/articles/setting-your-email-in-git/[user name and
Apache e-mail in git]
+ * https://github.com/apache/opennlp-sandbox[window=_blank]
+ * https://github.com/apache/opennlp-addons[window=_blank]
+ * https://github.com/apache/opennlp-site[window=_blank]
+ * https://github.com/apache/opennlp[window=_blank]
+- Configure your
https://help.github.com/articles/setting-your-email-in-git/[user name and
Apache e-mail in git,window=_blank]
## Configuring the upstream remote
@@ -50,7 +50,7 @@ Your repository should have two remotes, the upstream remote,
and the default or
## Merge a Pull Request via GitHub
-Please do not commit directly to the main branch. All changes are done via
Pull Requests, and a Pull Request needs to get two positive reviews and no
change requests until it
https://git-scm.com/docs/git-merge#_fast_forward_merge[can be merged]. The PR
can be merged via the Github UI as described below or manually. Please also
note that we do not use merge commits, the merge should be done using
https://git-scm.com/docs/git-merge#_fast_forward_merge[fast forward merging].
+Please do not commit directly to the main branch. All changes are done via
Pull Requests, and a Pull Request needs to get two positive reviews and no
change requests until it
https://git-scm.com/docs/git-merge#_fast_forward_merge[can be
merged,window=_blank]. The PR can be merged via the Github UI as described
below or manually. Please also note that we do not use merge commits, the merge
should be done using
https://git-scm.com/docs/git-merge#_fast_forward_merge[fast forward merging,win
[...]
To merge a PR via Github follow these steps:
