Configure name/description for all modules
authorMatt Sicker <boards@gmail.com>
Sun, 15 Jan 2017 02:56:42 +0000 (20:56 -0600)
committerMatt Sicker <boards@gmail.com>
Sun, 15 Jan 2017 02:56:42 +0000 (20:56 -0600)
27 files changed:
advertiser/jmdns/pom.xml
appender/activemq/pom.xml
appender/async-conversant/pom.xml
appender/async-jctools/pom.xml
appender/cassandra/pom.xml
appender/compress/pom.xml
appender/couchdb/pom.xml
appender/jms/pom.xml
appender/jpa/pom.xml
appender/kafka/pom.xml
appender/mongodb/pom.xml
appender/smtp/pom.xml
appender/zeromq/pom.xml
async/pom.xml
compat/pom.xml
config/json/pom.xml
config/yaml/pom.xml
core/pom.xml
layout/csv/pom.xml
layout/jansi/pom.xml
layout/json/pom.xml
layout/xml/pom.xml
layout/yaml/pom.xml
logback/pom.xml
script/groovy/pom.xml
spring/pom.xml
src/site/site.xml

index 7b55ce7..dc8877a 100644 (file)
 
   <artifactId>log4j-boot-advertiser-jmdns</artifactId>
 
+  <name>Log4j Boot jmDNS Advertiser</name>
+  <description>
+    Log4j Boot jmDNS Advertiser provides the necessary dependencies to configure an advertiser based on jmDNS, a
+    Bonjour-compatible multicast DNS library.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index 8ade4f8..a8f24de 100644 (file)
 
   <artifactId>log4j-boot-appender-activemq</artifactId>
 
+  <name>Log4j Boot ActiveMQ Appender</name>
+  <description>
+    Log4j Boot ActiveMQ Appender provides the necessary dependencies to configure a JmsAppender using Apache ActiveMQ
+    as a client.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
       <scope>compile</scope>
     </dependency>
     <dependency>
+      <groupId>org.apache.logging.log4j.boot</groupId>
+      <artifactId>log4j-boot-appender-jms</artifactId>
+      <version>1.0-SNAPSHOT</version>
+      <scope>compile</scope>
+    </dependency>
+    <dependency>
       <groupId>org.apache.activemq</groupId>
       <artifactId>activemq-client</artifactId>
       <version>${activemqVersion}</version>
index 35046f6..491ce06 100644 (file)
 
   <artifactId>log4j-boot-appender-async-conversant</artifactId>
 
+  <name>Log4j Boot Conversant Async Appender</name>
+  <description>
+    Log4j Boot Conversant Async Appender provides the necessary dependencies to configure an AsyncAppender using the
+    Conversant Disruptor library.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index 1121a10..cc024f8 100644 (file)
 
   <artifactId>log4j-boot-appender-async-jctools</artifactId>
 
+  <name>Log4j Boot JCTools Async Appender</name>
+  <description>
+    Log4j Boot JCTools Async Appender provides the dependencies necessary to configure an AsyncAppender using the
+    JCTools library (MPSC).
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index d4089e6..bae94f6 100644 (file)
 
   <artifactId>log4j-boot-appender-cassandra</artifactId>
 
+  <name>Log4j Boot Cassandra Appender</name>
+  <description>
+    Log4j Boot Cassandra Appender provides the dependencies necessary to configure an Apache Cassandra appender using
+    the Datastax Cassandra driver.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index ffea2ea..dc56984 100644 (file)
 
   <artifactId>log4j-boot-appender-compress</artifactId>
 
+  <name>Log4j Boot Compress Appenders</name>
+  <description>
+    Log4j Boot Compress Appenders provides the necessary dependencies to configure rolling file appenders that compress
+    old log files into additional formats using Apache Commons Compress.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index ef8ab16..13d0373 100644 (file)
 
   <artifactId>log4j-boot-appender-couchdb</artifactId>
 
+  <name>Log4j Boot CouchDB Appender</name>
+  <description>
+    Log4j Boot CouchDB Appender provides the necessary dependencies to configure an Apache CouchDB appender.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index 73c7549..9df6846 100644 (file)
 
   <artifactId>log4j-boot-appender-jms</artifactId>
 
+  <name>Log4j Boot JMS Appender</name>
+  <description>
+    Log4j Boot JMS Appender provides the necessary dependencies to configure a JMS appender. This only relies on the
+    JMS API and requires JMS to be configured via JNDI at runtime.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index 91fb5fe..b84f73c 100644 (file)
 
   <artifactId>log4j-boot-appender-jpa</artifactId>
 
+  <name>Log4j Boot JPA Appender</name>
+  <description>
+    Log4j Boot JPA Appender provides the necessary dependencies to configure a JPA appender. This uses the JPA API and
+    requires a JPA provider at runtime.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index eac277d..3c7851b 100644 (file)
 
   <artifactId>log4j-boot-appender-kafka</artifactId>
 
+  <name>Log4j Boot Kafka Appender</name>
+  <description>
+    Log4j Boot Kafka Appender provides the necessary dependencies to configure an Apache Kafka appender.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index 3f3a6c4..ae50f94 100644 (file)
 
   <artifactId>log4j-boot-appender-mongodb</artifactId>
 
+  <name>Log4j Boot MongoDB Appender</name>
+  <description>
+    Log4j Boot MongoDB Appender provides the necessary dependencies to configure a MongoDB appender.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index b77a0b3..59cb88d 100644 (file)
 
   <artifactId>log4j-boot-appender-smtp</artifactId>
 
+  <name>Log4j Boot SMTP Appender</name>
+  <description>
+    Log4j Boot SMTP Appender provides the necessary dependencies to configure an SMTP appender.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index d586903..9bad12d 100644 (file)
 
   <artifactId>log4j-boot-appender-zeromq</artifactId>
 
+  <name>Log4j Boot ZeroMQ Appender</name>
+  <description>
+    Log4j Boot ZeroMQ Appender provides the necessary dependencies to configure a ZeroMQ appender using the JeroMQ
+    library.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index 7fd8f88..0faa0ef 100644 (file)
 
   <artifactId>log4j-boot-async</artifactId>
 
+  <name>Log4j Boot Async</name>
+  <description>
+    Log4j Boot Async provides the necessary dependencies to use AsyncLoggers based on the LMAX Disruptor library.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index 99eebc5..f3e5ff4 100644 (file)
   <modelVersion>4.0.0</modelVersion>
 
   <artifactId>log4j-boot-compat</artifactId>
+
+  <name>Log4j Boot Logging APIs</name>
+  <description>
+    Log4j Boot Logging APIs provides compatibility bridges between Log4j 2 API, SLF4J, Apache Commons Logging,
+    Log4j 1.x, and java.util.logging.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j</groupId>
index 96c5e4b..484bfe2 100644 (file)
 
   <artifactId>log4j-boot-config-json</artifactId>
 
+  <name>Log4j Boot JSON Configuration</name>
+  <description>
+    Log4j Boot JSON Configuration provides the necessary dependencies to support the JSON Log4j configuration file
+    format using Jackson.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index 7646649..c337ac1 100644 (file)
 
   <artifactId>log4j-boot-config-yaml</artifactId>
 
+  <name>Log4j Boot YAML Configuration</name>
+  <description>
+    Log4j Boot YAML Configuration provides the necessary dependencies to support the YAML Log4j configuration file
+    format using Jackson and SnakeYAML.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index e676157..839cc30 100644 (file)
 
   <artifactId>log4j-boot-core</artifactId>
 
+  <name>Log4j Boot Core</name>
+  <description>
+    Log4j Boot Core provides Log4j 2 API and Log4j 2 Core without any optional dependencies.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j</groupId>
index 6e5ae2a..02a9a32 100644 (file)
 
   <artifactId>log4j-boot-layout-csv</artifactId>
 
+  <name>Log4j Boot CSV Layout</name>
+  <description>
+    Log4j Boot CSV Layout provides the necessary dependencies to configure a CSV layout using Apache Commons CSV.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index 510130e..cf4a562 100644 (file)
 
   <artifactId>log4j-boot-layout-jansi</artifactId>
 
+  <name>Log4j Boot Jansi Layout</name>
+  <description>
+    Log4j Boot Jansi Layout provides the necessary dependencies to support colored log messages in Microsoft Windows
+    environments using Jansi.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index 8d307f6..dfad62e 100644 (file)
 
   <artifactId>log4j-boot-layout-json</artifactId>
 
+  <name>Log4j Boot JSON Layout</name>
+  <description>
+    Log4j Boot JSON Layout provides the necessary dependencies to configure a JSON layout using Jackson.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index 1fffd78..007e270 100644 (file)
 
   <artifactId>log4j-boot-layout-xml</artifactId>
 
+  <name>Log4j Boot XML Layout</name>
+  <description>
+    Log4j Boot XML Layout provides the necessary dependencies to configure a XML layout using Jackson.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index fe3a32c..728d230 100644 (file)
 
   <artifactId>log4j-boot-layout-yaml</artifactId>
 
+  <name>Log4j Boot YAML Layout</name>
+  <description>
+    Log4j Boot YAML Layout provides the necessary dependencies to configure a YAML layout using Jackson and SnakeYAML.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index 16e3a1b..21d29ab 100644 (file)
   <modelVersion>4.0.0</modelVersion>
 
   <artifactId>log4j-boot-logback</artifactId>
+
+  <name>Log4j Boot Logback</name>
+  <description>
+    Log4j Boot Logback provides Logback as a logging implementation paired with Log4j 2 API and any relevant logging
+    API bridges needed to centralize logging into a single configuration.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j</groupId>
index 5c28ed2..4c40324 100644 (file)
 
   <artifactId>log4j-boot-script-groovy</artifactId>
 
+  <name>Log4j Boot Groovy</name>
+  <description>
+    Log4j Boot Groovy provides Apache Groovy script support in configuration files. Groovy scripts can be used in many
+    configuration scenarios as an alternative to the built in JavaScript engine in the JDK.
+  </description>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j.boot</groupId>
index 5985328..8a815c5 100644 (file)
@@ -31,8 +31,8 @@
   <artifactId>log4j-boot-spring</artifactId>
   <name>Log4j Spring Boot Starter</name>
   <description>
-    Log4j Boot module for integration with Spring Boot. This module can be used as a complete replacement for
-    spring-boot-starter-logging or spring-boot-starter-log4j2.
+    Log4j Spring Boot Starter module for integration with Spring Boot. This module can be used as a complete replacement
+    for spring-boot-starter-logging or spring-boot-starter-log4j2.
   </description>
 
   <dependencies>
index 7eade2c..a41cb04 100644 (file)
 
     <menu name="&lt;i class='icon-star'&gt;&lt;/i&gt; Core Components">
       <item name="Core" href="/log4j-boot-core/index.html"/>
-      <item name="Logging API Implementations" href="/log4j-boot-compat/index.html"/>
-      <item name="Async Loggers" href="/log4j-boot-async/index.html"/>
+      <item name="Logging APIs" href="/log4j-boot-compat/index.html"/>
+      <item name="Async" href="/log4j-boot-async/index.html"/>
       <item name="Logback" href="/log4j-boot-logback/index.html"/>
     </menu>
 
     <menu name="&lt;i class='icon-search'&gt;&lt;/i&gt; Advertisers">
-      <item name="JMDNS" href="/log4j-boot-advertiser-jmdns/index.html"/>
+      <item name="jmDNS" href="/log4j-boot-advertiser-jmdns/index.html"/>
     </menu>
 
     <menu name="&lt;i class='icon-globe'&gt;&lt;/i&gt; Appenders">
       <item name="ActiveMQ" href="/log4j-boot-appender-activemq/index.html"/>
-      <item name="Async (Conversant)" href="/log4j-boot-appender-async-conversant/index.html"/>
-      <item name="Async (JCTools)" href="/log4j-boot-appender-async-jctools/index.html"/>
+      <item name="Conversant Async" href="/log4j-boot-appender-async-conversant/index.html"/>
       <item name="Cassandra" href="/log4j-boot-appender-cassandra/index.html"/>
       <item name="Compress" href="/log4j-boot-appender-compress/index.html"/>
       <item name="CouchDB" href="/log4j-boot-appender-couchdb/index.html"/>
+      <item name="JCTools Async" href="/log4j-boot-appender-async-jctools/index.html"/>
       <item name="JMS" href="/log4j-boot-appender-jms/index.html"/>
       <item name="JPA" href="/log4j-boot-appender-jpa/index.html"/>
       <item name="Kafka" href="/log4j-boot-appender-kafka/index.html"/>
@@ -86,7 +86,7 @@
 
     <menu name="&lt;i class='icon-file'&gt;&lt;/i&gt; Layouts">
       <item name="CSV" href="/log4j-boot-layout-csv/index.html"/>
-      <item name="JANSI" href="/log4j-boot-layout-jansi/index.html"/>
+      <item name="Jansi" href="/log4j-boot-layout-jansi/index.html"/>
       <item name="JSON" href="/log4j-boot-layout-json/index.html"/>
       <item name="XML" href="/log4j-boot-layout-xml/index.html"/>
       <item name="YAML" href="/log4j-boot-layout-yaml/index.html"/>