#BAEL-17524 add README descriptions (#7957)

2019-10-09 16:45:39 +02:00 · 2019-10-09 16:45:39 +02:00 · 36da8820a0
parent d801f7c38f
commit 36da8820a0
12 changed files with 57 additions and 6 deletions
--- a/lombok/README.md
+++ b/lombok/README.md
@ -1,4 +1,8 @@
-## Relevant Articles:
+## Project Lombok
+
+This module contains articles about Project Lombok.
+
+### Relevant Articles:
 - [Introduction to Project Lombok](https://www.baeldung.com/intro-to-project-lombok)
 - [Using Lombok’s @Builder Annotation](https://www.baeldung.com/lombok-builder)
 - [Using Lombok’s @Getter for Boolean Fields](https://www.baeldung.com/lombok-getter-boolean)
--- a/lucene/README.md
+++ b/lucene/README.md
@ -1,3 +1,7 @@
+## Apache Lucene
+
+This module contains articles about Apache Lucene.
+
 ### Relevant Articles:

 - [Introduction to Apache Lucene](https://www.baeldung.com/lucene)
--- a/mapstruct/README.md
+++ b/mapstruct/README.md
@ -1,2 +1,6 @@
+## MapStruct
+
+This module contains articles about MapStruct.
+
 ###Relevant Articles:
 - [Quick Guide to MapStruct](https://www.baeldung.com/mapstruct)
--- a/maven-all/README.md
+++ b/maven-all/README.md
@ -1,3 +1,7 @@
+## Apache Maven
+
+This module contains articles about Apache Maven. Please refer to its submodules.
+
 ### Relevant Articles

 - [Apache Maven Tutorial](https://www.baeldung.com/maven)
--- a/maven-all/maven-war-plugin/README.md
+++ b/maven-all/maven-war-plugin/README.md
@ -1,3 +1,7 @@
+## Maven WAR Plugin
+
+This module contains articles about the Maven WAR Plugin.
+
 ### Relevant Articles

 - [Eclipse Error: web.xml is missing and failOnMissingWebXml is set to true](https://www.baeldung.com/eclipse-error-web-xml-missing)
--- a/maven-all/maven/README.md
+++ b/maven-all/maven/README.md
@ -1,3 +1,8 @@
+## Apache Maven
+
+This module contains articles about core Apache Maven. Articles about other Maven plugins (such as the Maven WAR Plugin)
+have their own dedicated modules. 
+
 ### Relevant Articles

 - [Guide to the Core Maven Plugins](https://www.baeldung.com/core-maven-plugins)
--- a/maven-all/profiles/README.md
+++ b/maven-all/profiles/README.md
@ -1,3 +1,7 @@
+## Maven Profiles
+
+This module contains articles about Maven profiles.
+
 ### Relevant Articles

 - [Guide to Maven Profiles](https://www.baeldung.com/maven-profiles)
--- a/maven-all/versions-maven-plugin/README.md
+++ b/maven-all/versions-maven-plugin/README.md
@ -1,3 +1,7 @@
+## Versions Maven Plugin
+
+This module contains articles about the Versions Maven Plugin.
+
 ### Relevant Articles

 - [Use the Latest Version of a Dependency in Maven](https://www.baeldung.com/maven-dependency-latest-version)
--- a/maven-archetype/README.md
+++ b/maven-archetype/README.md
@ -1,4 +1,7 @@
+## Maven Archetype
+
+This module contains articles about the Maven Archetype Plugin.
+
 ### Relevant Articles: 
-================================

 - [Guide to Maven Archetype](https://www.baeldung.com/maven-archetype)
--- a/maven-java-11/README.md
+++ b/maven-java-11/README.md
@ -0,0 +1,7 @@
+## Maven and Java 11
+
+This module contains articles about Maven with Java 11+.
+
+### Relevant Articles: 
+
+- [Multi-Module Maven Application with Java Modules](https://www.baeldung.com/maven-multi-module-project-java-jpms)
--- a/maven-polyglot/README.md
+++ b/maven-polyglot/README.md
@ -1,3 +1,7 @@
+## Maven Polyglot
+
+This module contains articles about Maven Polyglot.
+
 To run the maven-polyglot-json-app successfully, you first have to build the maven-polyglot-json-extension module using: mvn clean install.

 ### Relevant Articles: 
--- a/mesos-marathon/README.md
+++ b/mesos-marathon/README.md
@ -1,3 +1,7 @@
+## Marathon and Mesos
+
+This module contains articles about Marathon and Mesos.
+
 ### Relevant articles

 - [Simple Jenkins Pipeline with Marathon and Mesos](https://www.baeldung.com/jenkins-pipeline-with-marathon-mesos)