bom docs (#1256)

* feat: add bom * docs: add maven coordinates for all libraries and bom
paulcwarren · Feb 3, 2023 · 2824c62 · 2824c62
1 parent 695ce4f
commit 2824c62
Show file tree

Hide file tree

Showing 12 changed files with 242 additions and 1 deletion.
diff --git a/spring-content-azure-storage/src/main/asciidoc/azure.adoc b/spring-content-azure-storage/src/main/asciidoc/azure.adoc
@@ -1,5 +1,25 @@
 = Azure Storage
 
+== Maven Central Coordinates
+The maven coordinates for this Spring Content library are as follows:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-azure-storage</artifactId>
+</dependency>
+```
+
+As it is usual to use several Spring Content libraries together importing the bom is recommended:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-bom</artifactId>
+    <version>${spring-content-version}</version>
+    <type>pom</type>
+    <scope>import</scope>
+</dependency>
+```
+
 == Annotation-based Configuration
 
 Spring Content Azure Storage is enabled with the following Java Config.

diff --git a/spring-content-cmis/src/main/asciidoc/cmis.adoc b/spring-content-cmis/src/main/asciidoc/cmis.adoc
@@ -1,5 +1,24 @@
 = CMIS Integration
 
+== Maven Central Coordinates
+The maven coordinates for this Spring Content library are as follows:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-cmis</artifactId>
+</dependency>
+```
+
+As it is usual to use several Spring Content libraries together importing the bom is recommended:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-bom</artifactId>
+    <version>${spring-content-version}</version>
+    <type>pom</type>
+    <scope>import</scope>
+</dependency>
+```
 Spring Content CMIS supports the CMIS browser (JSON) bindings.
 
 These bindings can be used as an alternative to the endpoints exported by Spring Content REST.  This may be desirable

diff --git a/spring-content-elasticsearch/src/main/asciidoc/elasticsearch.adoc b/spring-content-elasticsearch/src/main/asciidoc/elasticsearch.adoc
@@ -5,6 +5,26 @@
 
 When enabled, the Elasticsearch integration will, by default, forward all content to an Elasticsearch cluster for fulltext indexing.
 
+== Maven Central Coordinates
+The maven coordinates for this Spring Content library are as follows:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-elasticsearch</artifactId>
+</dependency>
+```
+
+As it is usual to use several Spring Content libraries together importing the bom is recommended:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-bom</artifactId>
+    <version>${spring-content-version}</version>
+    <type>pom</type>
+    <scope>import</scope>
+</dependency>
+```
+
 == Annotation-based Configuration
 
 Spring Content Elasticsearch requires a `RestHighLevelClient` bean that is used as the connection to your Elasticsearch

diff --git a/spring-content-encryption/src/main/asciidoc/enc.adoc b/spring-content-encryption/src/main/asciidoc/enc.adoc
@@ -1,5 +1,27 @@
 = Content Encryption
 
+== Maven Central Coordinates
+The maven coordinates for this Spring Content library are as follows:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-encryption</artifactId>
+</dependency>
+```
+
+As it is usual to use several Spring Content libraries together importing the bom is recommended:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-bom</artifactId>
+    <version>${spring-content-version}</version>
+    <type>pom</type>
+    <scope>import</scope>
+</dependency>
+```
+
+== Adding Encryption to your ContentStores
+
 Spring Content Encryption adds the interface `EncryptingContentStore` that can be used to decorate a `Store`
 to provide at-rest encryption of the content in that Store.
 

diff --git a/spring-content-fs/src/main/asciidoc/fs.adoc b/spring-content-fs/src/main/asciidoc/fs.adoc
@@ -1,5 +1,25 @@
 = Filesystem Content Stores
 
+== Maven Central Coordinates
+The maven coordinates for this Spring Content library are:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-fs</artifactId>
+</dependency>
+```
+
+As it is usual to use several Spring Content libraries together importing the bom is recommended:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-bom</artifactId>
+    <version>${spring-content-version}</version>
+    <type>pom</type>
+    <scope>import</scope>
+</dependency>
+```
+
 == Annotation-based Configuration
 
 Spring Content Filesystem Stores are enabled with the following Java Config.

diff --git a/spring-content-gcs/src/main/asciidoc/gcs.adoc b/spring-content-gcs/src/main/asciidoc/gcs.adoc
@@ -1,5 +1,25 @@
 = GCS Content Stores
 
+== Maven Central Coordinates
+The maven coordinates for this Spring Content library are as follows:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-gcs</artifactId>
+</dependency>
+```
+
+As it is usual to use several Spring Content libraries together importing the bom is recommended:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-bom</artifactId>
+    <version>${spring-content-version}</version>
+    <type>pom</type>
+    <scope>import</scope>
+</dependency>
+```
+
 == Annotation-based Configuration
 
 Spring Content GCS is enabled with the following Java Config.

diff --git a/spring-content-jpa/src/main/asciidoc/jpa.adoc b/spring-content-jpa/src/main/asciidoc/jpa.adoc
@@ -1,5 +1,25 @@
 = JPA Content Stores
 
+== Maven Central Coordinates
+The maven coordinates for this Spring Content library are as follows:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-jpa</artifactId>
+</dependency>
+```
+
+As it is usual to use several Spring Content libraries together importing the bom is recommended:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-bom</artifactId>
+    <version>${spring-content-version}</version>
+    <type>pom</type>
+    <scope>import</scope>
+</dependency>
+```
+
 == Annotation based configuration
 
 Spring Content JPA Stores are enabled with the following Java Config.

diff --git a/spring-content-mongo/src/main/asciidoc/mongo.adoc b/spring-content-mongo/src/main/asciidoc/mongo.adoc
@@ -1,5 +1,25 @@
 = MongoDB Content Stores
 
+== Maven Central Coordinates
+The maven coordinates for this Spring Content library are as follows:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-mongo</artifactId>
+</dependency>
+```
+
+As it is usual to use several Spring Content libraries together importing the bom is recommended:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-bom</artifactId>
+    <version>${spring-content-version}</version>
+    <type>pom</type>
+    <scope>import</scope>
+</dependency>
+```
+
 == Annotation based configuration
 
 Spring Content MongoDB Stores are enabled with the following Java Config.

diff --git a/spring-content-renditions/src/main/asciidoc/renditions.adoc b/spring-content-renditions/src/main/asciidoc/renditions.adoc
@@ -15,6 +15,26 @@ types to jpeg images based on the apache poi and pdfbox libraries
 You can also add the `spring-content-docx4j` dependency to your project for an additional small set of renderers that
 can convert documents between Microsoft Word, Adobe PDF and HTML based on the docx4j library.
 
+== Maven Central Coordinates
+The maven coordinates for this Spring Content library are as follows:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-renditions</artifactId>
+</dependency>
+```
+
+As it is usual to use several Spring Content libraries together importing the bom is recommended:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-bom</artifactId>
+    <version>${spring-content-version}</version>
+    <type>pom</type>
+    <scope>import</scope>
+</dependency>
+```
+
 == Annotation-based Configuration
 
 .Enabling Spring Content Renditions with Java Config

diff --git a/spring-content-rest/src/main/asciidoc/rest-store.adoc b/spring-content-rest/src/main/asciidoc/rest-store.adoc
@@ -17,7 +17,27 @@ Spring Content REST officially supports:
 
 == Introduction
 
-Spring Content REST is itself a Spring MVC application and is designed in such a way that it should integrate with your existing Spring MVC applications with very little effort. 
+Spring Content REST is itself a Spring MVC application and is designed in such a way that it should integrate with your existing Spring MVC applications with very little effort.
+
+== Maven Central Coordinates
+The maven coordinates for this Spring Content library are as follows:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-rest</artifactId>
+</dependency>
+```
+
+As it is usual to use several Spring Content libraries together importing the bom is recommended:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-bom</artifactId>
+    <version>${spring-content-version}</version>
+    <type>pom</type>
+    <scope>import</scope>
+</dependency>
+```
 
 == Adding Spring Content REST to a Spring Boot project
 

diff --git a/spring-content-s3/src/main/asciidoc/s3.adoc b/spring-content-s3/src/main/asciidoc/s3.adoc
@@ -1,5 +1,25 @@
 = S3 Content Stores
 
+== Maven Central Coordinates
+The maven coordinates for this Spring Content library are as follows:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-s3</artifactId>
+</dependency>
+```
+
+As it is usual to use several Spring Content libraries together importing the bom is recommended:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-bom</artifactId>
+    <version>${spring-content-version}</version>
+    <type>pom</type>
+    <scope>import</scope>
+</dependency>
+```
+
 == Annotation based configuration
 
 Spring Content S3 is enabled with the following Java Config.

diff --git a/spring-content-solr/src/main/asciidoc/solr.adoc b/spring-content-solr/src/main/asciidoc/solr.adoc
@@ -1,6 +1,26 @@
 [[fulltext-search]]
 = Fulltext Indexing & Searching with Solr
 
+== Maven Central Coordinates
+The maven coordinates for this Spring Content library are as follows:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-solr</artifactId>
+</dependency>
+```
+
+As it is usual to use several Spring Content libraries together importing the bom is recommended:
+```xml
+<dependency>
+    <groupId>com.github.paulcwarren</groupId>
+    <artifactId>spring-content-bom</artifactId>
+    <version>${spring-content-version}</version>
+    <type>pom</type>
+    <scope>import</scope>
+</dependency>
+```
+
 == Overview
 
 When enabled, the Solr integration will forward all content to an Solr cluster for fulltext indexing.