From 36da8820a0a69ee0698ede88d173856f619ed360 Mon Sep 17 00:00:00 2001 From: Alessio Stalla Date: Wed, 9 Oct 2019 16:45:39 +0200 Subject: [PATCH] #BAEL-17524 add README descriptions (#7957) --- lombok/README.md | 6 +++++- lucene/README.md | 4 ++++ mapstruct/README.md | 4 ++++ maven-all/README.md | 6 +++++- maven-all/maven-war-plugin/README.md | 6 +++++- maven-all/maven/README.md | 5 +++++ maven-all/profiles/README.md | 6 +++++- maven-all/versions-maven-plugin/README.md | 6 +++++- maven-archetype/README.md | 5 ++++- maven-java-11/README.md | 7 +++++++ maven-polyglot/README.md | 4 ++++ mesos-marathon/README.md | 4 ++++ 12 files changed, 57 insertions(+), 6 deletions(-) create mode 100644 maven-java-11/README.md diff --git a/lombok/README.md b/lombok/README.md index 54a0984159..39d3cd6b05 100644 --- 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) diff --git a/lucene/README.md b/lucene/README.md index 2bfd8bf4e1..ad83f26386 100644 --- 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) diff --git a/mapstruct/README.md b/mapstruct/README.md index 92c55a131d..b784820b98 100644 --- 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) diff --git a/maven-all/README.md b/maven-all/README.md index d014f323d2..b20d944b14 100644 --- 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) \ No newline at end of file +- [Apache Maven Tutorial](https://www.baeldung.com/maven) diff --git a/maven-all/maven-war-plugin/README.md b/maven-all/maven-war-plugin/README.md index d559fea80b..09d33772f0 100644 --- 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) \ No newline at end of file +- [Eclipse Error: web.xml is missing and failOnMissingWebXml is set to true](https://www.baeldung.com/eclipse-error-web-xml-missing) diff --git a/maven-all/maven/README.md b/maven-all/maven/README.md index acf7dfc47b..ced4a52703 100644 --- 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) diff --git a/maven-all/profiles/README.md b/maven-all/profiles/README.md index 22d5d7f70c..cfbe5c397f 100644 --- 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) \ No newline at end of file +- [Guide to Maven Profiles](https://www.baeldung.com/maven-profiles) diff --git a/maven-all/versions-maven-plugin/README.md b/maven-all/versions-maven-plugin/README.md index 8f5670f802..19414a2a4b 100644 --- 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) \ No newline at end of file +- [Use the Latest Version of a Dependency in Maven](https://www.baeldung.com/maven-dependency-latest-version) diff --git a/maven-archetype/README.md b/maven-archetype/README.md index b707150854..ba5a83fe14 100644 --- 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) diff --git a/maven-java-11/README.md b/maven-java-11/README.md new file mode 100644 index 0000000000..fcb6ea3f06 --- /dev/null +++ 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) diff --git a/maven-polyglot/README.md b/maven-polyglot/README.md index 8635c8eddf..037b921ae7 100644 --- 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: diff --git a/mesos-marathon/README.md b/mesos-marathon/README.md index 09467ebfcb..65b2361698 100644 --- 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)