updating Gradle setup instructions

Author: Carey-AWS

doc_source/setup-project-gradle.rst

@@ -1,4 +1,4 @@
-.. Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+.. Copyright 2010-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
    This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
    International License (the "License"). You may not use this file except in compliance with the
@@ -12,41 +12,52 @@
 Using the SDK with Gradle
 #########################
 
+
+Project setup for Gradle 4.6 or higher
+===============
+
 `Since Gradle 4.6 <https://docs.gradle.org/4.6/release-notes.html#bom-import>`_ it is possible to
 use Gradle's improved POM support feature for importing bill of materials (BOM) files by simply declaring a dependency on a BOM.
 
-.. topic:: To configure the SDK for Gradle 4.6 and upper
+To manage SDK dependencies for your Gradle_ project, import the |sdk-java|'s Maven Bill of Materials (BOM) into the :file:`build.gradle` file.
+
+.. note:: Replace *1.11.X* in the build file examples below with a valid version of the |sdk-java|. Find the latest version in the 
+          `AWS SDK for Java 1.11.x Reference <https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/index.html>`_
+
 
-    #. Enable `IMPROVED_POM_SUPPORT` feature in :file:`settings.gradle` file (not needed in Gradle 5 and upper)
+.. topic:: To configure the |sdk-java| for Gradle 4.6 or higher:
+
+    #. If you are using Gradle 5.0 or higher, skip to Step 2. Otherwise, enable the `IMPROVED_POM_SUPPORT` feature in the :file:`settings.gradle` file
 
        .. code-block:: groovy
 
           enableFeaturePreview('IMPROVED_POM_SUPPORT')
 
-    #. Import BOM as a usual dependency in the *dependencies* section
+    #. Add the BOM to the *dependencies* section of the :file:`build.gradle` file.
 
        .. code-block:: groovy
 
+          ...
           dependencies {
-              implementation platform('com.amazonaws:aws-java-sdk-bom:1.11.228')
+              implementation platform('com.amazonaws:aws-java-sdk-bom:1.11.X')
+
+              // Declare individual SDK dependencies without version
+              ...
           }
 
-    #. Specify the SDK modules that you'll be using in the *dependencies* section
+    #. Specify the SDK modules you want to use in the *dependencies* section. For example, the following includes a dependency for |S3long|.
 
        .. code-block:: groovy
 
+          ...
           dependencies {
               implementation 'com.amazonaws:aws-java-sdk-s3'
-              testCompile group: 'junit', name: 'junit', version: '4.11'
+              ...
           }
 
-Gradle will automatically resolve the correct version of your SDK dependencies using the information
-from the BOM.
-
-You can also refer to the *AWS Code Catalog* to learn what dependencies to use for a given AWS service. Refer to the POM file under a specific service example.
-For example, if you are interested in the dependencies for the AWS S3 service (as shown in the previous dependencies example), see the :sdk-examples-java-s3:`complete example <GetAcl.java>` on GitHub. (Look at the pom under /java/example_code/s3).
+Gradle automatically resolves the correct version of your SDK dependencies using the information from the BOM.
 
-Here's the complete :file:`build.gradle` file:
+The following is an example of a complete :file:`build.gradle` file that includes a dependency for |S3|:
 
 .. code-block:: groovy
 
@@ -62,18 +73,27 @@ Here's the complete :file:`build.gradle` file:
    }
 
    dependencies {
-       implementation platform('com.amazonaws:aws-java-sdk-bom:1.11.228')
-       implementation 'com.amazonaws:aws-java-sdk-s3'
-       testCompile group: 'junit', name: 'junit', version: '4.11'
+     implementation platform('com.amazonaws:aws-java-sdk-bom:1.11.X')
+     implementation 'com.amazonaws:aws-java-sdk-s3'
+     testCompile group: 'junit', name: 'junit', version: '4.11'
    }
 
-Gradle versions prior to 4.6 lack of native BOM support, so Spring's `dependency management plugin
-<https://github.com/spring-gradle-plugins/dependency-management-plugin>`_ for Gradle can be used
-to import the SDK's Maven Bill of Materials (BOM) to manage SDK dependencies for your project.
+.. note:: Replace the dependency for |S3| above with the dependency or dependencies of the Amazon service(s) you will be using in your project. The modules (dependencies) that are managed by the |sdk-java| BOM are listed on Maven Central (https://mvnrepository.com/artifact/com.amazonaws/aws-java-sdk-bom/latest).
+
+
+Project setup for Gradle versions prior to 4.6
+===============
+
+Gradle versions prior to 4.6 lack native BOM support. To manage |sdk-java| dependencies for your project,
+use Spring's `dependency management plugin
+<https://github.com/spring-gradle-plugins/dependency-management-plugin>`_ for Gradle to import the SDK's Maven Bill of Materials (BOM).
 
-.. topic:: To configure the SDK for Gradle prior 4.6
+.. note:: Replace *1.11.X* in the build file examples below with a valid version of the |sdk-java|. Find the latest version in the 
+          `AWS SDK for Java 1.11.x Reference <https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/index.html>`_
 
-    #. Add the dependency management plugin to your :file:`build.gradle` file
+.. topic:: To configure the SDK for Gradle versions prior to 4.6:
+
+    #. Add the dependency management plugin to your :file:`build.gradle` file.
 
        .. code-block:: groovy
 
@@ -82,40 +102,38 @@ to import the SDK's Maven Bill of Materials (BOM) to manage SDK dependencies for
                   mavenCentral()
               }
               dependencies {
-                  classpath "io.spring.gradle:dependency-management-plugin:1.0.3.RELEASE"
+                  classpath "io.spring.gradle:dependency-management-plugin:1.0.9.RELEASE"
               }
           }
 
           apply plugin: "io.spring.dependency-management"
 
-    #. Add the BOM to the *dependencyManagement* section of the file
+    #. Add the BOM to the *dependencyManagement* section of the file.
 
        .. code-block:: groovy
 
           dependencyManagement {
               imports {
-                  mavenBom 'com.amazonaws:aws-java-sdk-bom:1.11.228'
+                  mavenBom 'com.amazonaws:aws-java-sdk-bom:1.11.X'
               }
           }
 
-    #. Specify the SDK modules that you'll be using in the *dependencies* section
+    #. Specify the SDK modules that you'll be using in the *dependencies* section. For example, the following includes a dependency for |S3long|.
 
        .. code-block:: groovy
 
           dependencies {
               compile 'com.amazonaws:aws-java-sdk-s3'
-              testCompile group: 'junit', name: 'junit', version: '4.11'
           }
 
-Gradle will automatically resolve the correct version of your SDK dependencies using the information
-from the BOM.
+Gradle automatically resolves the correct version of your SDK dependencies using the information from the BOM.
 
-Here's the complete :file:`build.gradle` file:
+The following is an example of a complete :file:`build.gradle` file that includes a dependency for |S3|:
 
 .. code-block:: groovy
 
    group 'aws.test'
-   version '1.0-SNAPSHOT'
+   version '1.0'
 
    apply plugin: 'java'
 
@@ -127,18 +145,18 @@ Here's the complete :file:`build.gradle` file:
 
    buildscript {
      repositories {
-         mavenCentral()
+       mavenCentral()
      }
      dependencies {
-         classpath "io.spring.gradle:dependency-management-plugin:1.0.3.RELEASE"
+       classpath "io.spring.gradle:dependency-management-plugin:1.0.9.RELEASE"
      }
    }
 
    apply plugin: "io.spring.dependency-management"
 
    dependencyManagement {
      imports {
-         mavenBom 'com.amazonaws:aws-java-sdk-bom:1.11.228'
+       mavenBom 'com.amazonaws:aws-java-sdk-bom:1.11.X'
      }
    }
 
@@ -147,5 +165,7 @@ Here's the complete :file:`build.gradle` file:
      testCompile group: 'junit', name: 'junit', version: '4.11'
    }
 
-.. note:: For more detail about specifying SDK dependencies using the BOM, see
-   :doc:`setup-project-maven`.
+.. note:: Replace the dependency for |S3| above with the dependency or dependencies of the Amazon service(s) you will be using in your project. The modules (dependencies) that are managed by the |sdk-java| BOM are listed on Maven Central (https://mvnrepository.com/artifact/com.amazonaws/aws-java-sdk-bom/latest).
+
+For more detail about specifying SDK dependencies using the BOM, see
+:doc:`setup-project-maven`.