Merge pull request #23 from oracle/topic_spalared_sync_with_bitbucket

Documentation changes, plugin to flatten pom, plugin to generate checksum files. Added name, description, url, developers and scm details in poms

Author: SatishPalareddy

README.md

@@ -26,9 +26,9 @@ For a deep dive into the project, refer to the Spring Cloud OCI documentation:
 
 This project has dependency and transitive dependencies on Spring Projects. The table below outlines the versions of Spring Cloud, Spring Boot and Spring Framework versions that are compatible with certain Spring Cloud OCI version.
 
-| Spring Cloud OCI  | Spring Cloud    | Spring Boot         | OCI Java SDK |
-|-------------------|-----------------|---------------------|--------------|
-| 1.0.0  	        | 2021.0.x        | 2.7.x               |  3.19.0      |
+| Spring Cloud OCI  | Spring Cloud              | Spring Boot         | OCI Java SDK |
+|-------------------|---------------------------|---------------------|--------------|
+| 1.0.0  	        | 2021.0.x                  | 2.7.x               |  3.19.0      |
 
 
 ## Try out samples

docs/pom.xml

@@ -10,7 +10,7 @@ Licensed under the Universal Permissive License v 1.0 as shown at https://oss.or
 	<parent>
 		<groupId>org.springframework.cloud</groupId>
 		<artifactId>spring-cloud-build</artifactId>
-		<version>3.1.5</version>
+		<version>4.0.4</version>
 		<relativePath/>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>

docs/src/main/asciidoc/core.adoc

@@ -27,22 +27,22 @@ dependencies {
 
 === Authentication Configuration
 
-Spring Cloud OCI allows you to authenticate with OCI with various following available options.
+Spring Cloud OCI allows you to authenticate with OCI using various available options.
 
-==== Config File Based Authentication
+==== Configuration File Based Authentication
 
-By default config file based authentication is enabled, to set it explicitly set the property spring.cloud.oci.config.type to `FILE`. There are below optional configuration to choose custom config profile name and config file name.
+By default, configuration file based authentication is enabled. To set it explicitly, set the property `spring.cloud.oci.config.type` to `FILE`. The following are optional configurations to set a custom configuration profile name and file name.
 
 ----
 spring.cloud.oci.config.profile = DEFAULT
 spring.cloud.oci.config.file = <FILE_PATH>
 ----
 
-For further details about the Authentication config file refer https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm[SDK and CLI Configuration File]
+For further details about the Authentication configuration file, refer https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm[SDK and CLI Configuration File]
 
 ==== Simple Authentication
 
-Set the property spring.cloud.oci.config.type to `SIMPLE` and add below properties:
+Set the property `spring.cloud.oci.config.type` to `SIMPLE` and add the following properties:
 
 ----
 spring.cloud.oci.config.type = SIMPLE
@@ -53,40 +53,40 @@ spring.cloud.oci.config.privateKey = <PRIVATE_KEY_FILE_PATH>
 spring.cloud.oci.config.passPhrase = <PASS_PHRASE>
 spring.cloud.oci.config.region = <REGION>
 ----
-Note: All the above properties are mandatory except spring.cloud.oci.config.passPhrase
+Note: All the preceding properties are mandatory except `spring.cloud.oci.config.passPhrase`
 
 ==== Instance Principal Configuration
 
-Set the config.type to `INSTANCE_PRINCIPAL` as below.
+Set the config.type to `INSTANCE_PRINCIPAL` as shown here.
 
 ----
 spring.cloud.oci.config.type = INSTANCE_PRINCIPAL
 ----
-For further details refer https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm[OCI Instance Principal Authentication]
+For further details, refer to https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm[OCI Instance Principal Authentication]
 
 ==== Resource Principal Configuration
 
-Set the config.type to `RESOURCE_PRINCIPAL` as below.
+Set the config.type to `RESOURCE_PRINCIPAL` as shown here.
 
 ----
 spring.cloud.oci.config.type = RESOURCE_PRINCIPAL
 ----
 
-For further details refer https://docs.public.oneportal.content.oci.oraclecloud.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal[OCI Resource Principal Authentication]
+For further details, refer to https://docs.public.oneportal.content.oci.oraclecloud.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal[OCI Resource Principal Authentication]
 
 === Region Configuration
 
-OCI services are available in different regions. Based on the custom requirements, the user can host the application on different OCI regions. The below configuration allows to set specific region for the entire application.
+OCI services are available in different regions. Based on the custom requirements, you can host the application on different OCI regions. The following configuration allows you to set a specific region for the entire application.
 
 ----
 spring.cloud.oci.region.static = us-ashburn-1
 ----
 
-Region value set in the above property takes precedence over the property `spring.cloud.oci.config.region` and `region` from the Authentication config file
+Region value set in the preceding property takes precedence over the property `spring.cloud.oci.config.region` and `region` from the Authentication configuration file
 
 === Compartment Configuration
 
-A compartment is a logical container, to organize and control access to the Oracle Cloud Infrastructure (OCI) Resources (Compute, Storage, Network, Load Balancer, etc) created within that compartment. Below configuration allows you to set default compartment for your application.
+A compartment is a logical container, used to organize and control access to the OCI Resources (Compute, Storage, Network, Load Balancer, etc.) created within that compartment. The following configuration allows you to set the default compartment for your application.
 
 ----
 spring.cloud.oci.compartment.static = <COMPARTMENT_OCID>

docs/src/main/asciidoc/getting-started.adoc

@@ -3,11 +3,11 @@
 
 == Getting Started
 
-This section describes how to get up to speed with Spring Cloud OCI libraries.
+This section describes how to get started using Spring Cloud OCI libraries.
 
-=== Spring Cloud OCI maven dependency management
+=== Spring Cloud OCI
 
-Spring Cloud OCI module dependencies can be used directly in Maven with a direct configuration of the particular module. The Spring Cloud OCI module includes all transitive dependencies for the Spring modules and also the OCI SDK that are needed to operate the modules. The general dependency configuration will look like this:
+Spring Cloud OCI module dependencies can be used directly in Maven with a direct configuration of the module. The Spring Cloud OCI module includes all transitive dependencies for the Spring modules, and the OCI SDK that are needed to operate the modules. The general dependency configuration will look like this:
 
 ----
 <dependencies>
@@ -19,20 +19,20 @@ Spring Cloud OCI module dependencies can be used directly in Maven with a direct
 </dependencies>
 ----
 
-Different modules can be included by replacing the module name with the respective one (e.g. `spring-cloud-oci-starter-storage` instead of `spring-cloud-oci-starter`)
+Different modules can be included by replacing the module name with the respective one (for example, `spring-cloud-oci-starter-storage` instead of `spring-cloud-oci-starter`)
 
 ==== Starter Dependencies
 
 Spring Cloud OCI offers https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-starters[starter dependencies] through Maven to easily depend on different modules of the library.
 Each starter contains all the dependencies and transitive dependencies needed to begin using their corresponding Spring Cloud OCI module.
 
-For example, if you wish to write a Spring application with Cloud Storage, you would include the `spring-cloud-oci-starter-storage` dependency in your project.
+For example, to write a Spring application with Cloud Storage, you include the `spring-cloud-oci-starter-storage` dependency in your project.
 You do *not* need to include the underlying `spring-cloud-oci-storage` dependency, because the `starter` dependency includes it.
 
-A summary of these artifacts are provided below.
+A summary of these artifacts is provided here.
 
 |===
-| Spring Cloud OCI Starter | Description | Maven Artifact Name
+^| Spring Cloud OCI Starter ^| Description ^| Maven Artifact Name
 
 | Core
 | Automatically configure authentication
@@ -53,10 +53,10 @@ There are a variety of resources to help you learn how to use Spring Cloud OCI l
 
 The easiest way to learn how to use Spring Cloud OCI is to consult the https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples[sample applications on Github].
 Spring Cloud OCI provides sample applications which demonstrate how to use every integration in the library.
-The table below highlights several samples of the most commonly used integrations in Spring Cloud OCI.
+The following table highlights several samples of the most used integrations in Spring Cloud OCI.
 
 |===
-| OCI Integration | Sample Application
+^| OCI Integration ^| Sample Application
 
 | Cloud Storage
 | https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples/spring-cloud-oci-storage-sample[spring-cloud-oci-storage-sample]

docs/src/main/asciidoc/index.adoc

@@ -10,11 +10,9 @@ include::_attributes.adoc[]
 
 == Introduction
 
-Spring Cloud for OCI, part of the Spring Cloud umbrella project, eases the integration with hosted OCI Services. It offers a convenient way to interact with OCI provided services using well-known Spring idioms and APIs, such as storage resources. Developers can build their application around the hosted services without having to care about infrastructure or maintenance.
+Spring Cloud for OCI, part of the Spring Cloud umbrella project, eases the integration with hosted OCI Services. It offers a convenient way to interact with OCI provided services using well-known Spring idioms and APIs, such as storage resources. Developers can build their application around the hosted services without having to worry about infrastructure or maintenance.
 
-Spring Cloud OCI lets you leverage the power and simplicity of the Spring Framework to:
-
-- Read and write from Spring Resources backed up by Oracle Cloud Storage
+Spring Cloud OCI lets you leverage the power and simplicity of the Spring Framework to read and write from Spring Resources backed up by Oracle Cloud Storage
 
 include::getting-started.adoc[]
 
@@ -28,14 +26,14 @@ include::logging.adoc[]
 
 == Configuration properties
 
-To see the list of all OCI related configuration properties please check link:appendix.html[the Appendix page].
+To see the list of all OCI-related configuration properties see the link:appendix.html[Appendix page].
 
 === Configuration Refresh
 
 The following properties are supported for Configuration auto-refresh at runtime without the need to restart applications
 
 |===
-|Name | Default
+^|Name ^| Default
 
 |spring.cloud.oci.config.profile | `DEFAULT`
 |spring.cloud.oci.config.file | NA

docs/src/main/asciidoc/logging.adoc

@@ -4,7 +4,7 @@
 [#cloud-logging]
 == Cloud Logging
 
-https://docs.oracle.com/en-us/iaas/Content/Logging/home.htm/[Oracle Cloud Infrastructure (OCI) Logging] service is a highly scalable and fully managed single pane of glass for all the logs in your tenancy. Logging provides access to logs from Oracle Cloud Infrastructure resources. These logs include critical diagnostic information that describes how resources are performing and being accessed. Use Logging to enable, manage, and search Audit, Service and Custom logs. The Spring Cloud module for OCI Logging allows ingesting logs associated with a logId.
+https://docs.oracle.com/en-us/iaas/Content/Logging/home.htm/[OCI Logging] service is a highly scalable and fully managed single pane of glass for all the logs in your tenancy. Logging provides access to logs from OCI resources. These logs include critical diagnostic information that describes how resources are performing and being accessed. Use Logging to enable, manage, and search Audit, Service, and Custom logs. The Spring Cloud module for OCI Logging allows ingesting logs associated with a logId.
 A Spring Boot starter is provided to auto-configure the Logging component.
 
 Maven coordinates, using <<getting-started.adoc#bill-of-materials, Spring Cloud OCI BOM>>:
@@ -29,7 +29,7 @@ dependencies {
 === Using Cloud Logging
 
 The starter automatically configures and registers a `Logging` bean in the Spring application context.
-The `Logging` bean (link[Javadoc]) can be used to ingest logs associated with a logId set in the property `spring.cloud.oci.logging.logId` in the application configuration file
+The `Logging` bean (link[Javadoc]) can be used to ingest logs associated with a logId specified in the property `spring.cloud.oci.logging.logId` within the application configuration file
 
 [source,java]
 ----
@@ -48,11 +48,11 @@ public void putLog() {
 The Spring Boot Starter for Oracle Cloud Logging provides the following configuration options:
 
 |===
-| Name | Description | Required | Default value
+^| Name ^| Description ^| Required ^| Default value
 | `spring.cloud.oci.logging.enabled` | Enables the OCI Logging APIs. | No | `true`
 |===
 
 
 === Sample
 
-A https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples/spring-cloud-oci-logging-sample[sample application] is available.
+A sample application provided https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples/spring-cloud-oci-logging-sample[here] contains the examples to demonstrates the usage of OCI Spring Cloud Logging module.

docs/src/main/asciidoc/notifications.adoc

@@ -4,7 +4,7 @@
 [#cloud-notifications]
 == Cloud Notifications
 
-https://www.oracle.com/in/devops/notifications/[Oracle Cloud Infrastructure (OCI) Notifications] is a highly available, low-latency publish/subscribe (pub/sub) service that sends alerts and messages to Oracle Cloud Functions, email, SMS, and message delivery partners, including Slack, PagerDuty and custom HTTPS endpoint. Spring Cloud module for Oracle Cloud Notifications allows to create a Topic and create and publish messages to multiple subsctiption types like Oracle Cloud Functions, email, SMS, Slack, PagerDuty and custom HTTPS endpoint.
+https://www.oracle.com/in/devops/notifications/[OCI Notifications] is a highly available, low latency publish/subscribe (pub/sub) service that sends alerts and messages to Oracle Cloud Functions, email, SMS, and message delivery partners, including Slack, PagerDuty and custom HTTPS endpoint. Spring Cloud module for Oracle Cloud Notifications allows you to create a Topic, then create and publish messages to multiple subscription types such as Oracle Cloud Functions, email, SMS, Slack, PagerDuty and custom HTTPS endpoint.
 A Spring Boot starter is provided to auto-configure the various Notification components.
 
 Maven coordinates, using <<getting-started.adoc#bill-of-materials, Spring Cloud OCI BOM>>:
@@ -29,7 +29,7 @@ dependencies {
 === Using Cloud Notifications
 
 The starter automatically configures and registers a `Notification` bean in the Spring application context.
-The `Notification` bean (link[Javadoc]) can be used to create Topic, create/list/get Subscription and publish message to the Subscriptions in a Topic.
+The `Notification` bean (link[Javadoc]) can be used to create a Topic, create, list, get a Subscription, and publish messages to the Subscriptions in a Topic.
 
 [source,java]
 ----
@@ -48,11 +48,11 @@ public void createTopic() {
 The Spring Boot Starter for Oracle Cloud Notifications provides the following configuration options:
 
 |===
-| Name | Description | Required | Default value
+^| Name ^| Description ^| Required ^| Default value
 | `spring.cloud.oci.notification.enabled` | Enables the OCI Notifications APIs. | No | `true`
 |===
 
 
 === Sample
 
-A https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples/spring-cloud-oci-notification-sample[sample application] is available.
+A sample application provided https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples/spring-cloud-oci-notification-sample[here] contains the examples to demonstrates the usage of OCI Spring Cloud Notification module.

docs/src/main/asciidoc/storage.adoc

@@ -4,7 +4,7 @@
 [#cloud-storage]
 == Cloud Storage
 
-https://www.oracle.com/in/cloud/storage/[Oracle Cloud Storage] allows storing any types of files.
+https://www.oracle.com/in/cloud/storage/[Oracle Cloud Storage] allows you to store any types of file.
 A Spring Boot starter is provided to auto-configure the various Storage components.
 
 Maven coordinates, using <<getting-started.adoc#bill-of-materials, Spring Cloud OCI BOM>>:
@@ -29,7 +29,7 @@ dependencies {
 === Using Cloud Storage
 
 The starter automatically configures and registers a `Storage` bean in the Spring application context.
-The `Storage` bean (link[Javadoc]) can be used to list/create/update/delete buckets and objects.
+The `Storage` bean (link[Javadoc]) can be used to list, create, update or delete buckets and objects.
 
 [source,java]
 ----
@@ -43,27 +43,24 @@ public void createBucketAndUploadFile() {
 }
 ----
 
-=== Cloud Storage Objects As Spring Resources
+=== Cloud Storage Objects Spring Resources
 
-https://docs.spring.io/spring/docs/current/spring-framework-reference/html/resources.html[Spring Resources] are an abstraction for a number of low-level resources, such as file system files, classpath files, servlet context-relative files, etc.
-Spring Cloud OCI adds a new resource type: a Oracle Cloud Storage (OCS) object.
+https://docs.spring.io/spring/docs/current/spring-framework-reference/html/resources.html[Spring Resources] are an abstraction for several low-level resources, such as file system files, classpath files, servlet context-relative files, etc.
+Spring Cloud OCI adds a new resource type: an Oracle Cloud Storage (OCS) object.
 
-The Spring Resource Abstraction for Oracle Cloud Storage allows OCS objects to be accessed by their OCS URL using the `@Value` annotation:
+The Spring Resource Abstraction for Oracle Cloud Storage allows OCS objects to be accessed by their OCS URL using the `@Value` annotation or the Spring application context:
 
 [source,java]
 ----
 @Value("ocs://[YOUR_OCS_BUCKET]/[OCS_FILE_NAME]")
 private Resource ocsResource;
 ----
 
-...or the Spring application context
-
 [source,java]
 ----
 SpringApplication.run(...).getResource("ocs://[YOUR_OCS_BUCKET]/[OCS_FILE_NAME]");
 ----
 
-
 This creates a `Resource` object that can be used to read the object, among https://docs.spring.io/spring/docs/current/spring-framework-reference/html/resources.html#resources-resource[other possible operations].
 
 Currently this resource is only readable.
@@ -73,11 +70,11 @@ Currently this resource is only readable.
 The Spring Boot Starter for Oracle Cloud Storage provides the following configuration options:
 
 |===
-| Name | Description | Required | Default value
+^| Name ^| Description ^| Required ^| Default value
 | `spring.cloud.oci.storage.enabled` | Enables the OCI storage APIs. | No | `true`
 |===
 
 
 === Sample
 
-A https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples/spring-cloud-oci-storage-sample[sample application] is available.
+A sample application provided https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples/spring-cloud-oci-storage-sample[here] contains the examples to demonstrate the usage of OCI Spring Cloud Storage module.