Merge pull request #1 from kritika-singh3/update-table-of-contents

Improve the table of contents

README.md

@@ -15,12 +15,32 @@ Table of Contents
 
   * [Building the code base](#building-the-code-base)
   * [Installing and configuring the plugin](docs/installation.md)
+    * [Prerequisites](docs/installation.md#prerequisites)
+        * [Configure ECS using the *AWS CloudFormation* template](docs/installation.md#configure-ecs-using-the-aws-cloudformation-template)
+        * [Alternatively configure ECS manually](docs/installation.md#alternatively-configure-ecs-manually)
+    * [Installation](docs/installation.md#installation)
+    * [Configuration](docs/installation.md#configuration)
+        * [Configure cluster profile(s)](docs/cluster_profile_configuration.md)
+            * [Cluster configuration](docs/cluster_profile_configuration.md#cluster-configuration)
+            * [Advanced Container Configuration](docs/cluster_profile_configuration.md#advanced-container-configuration)
+            * [AWS Credentials](docs/cluster_profile_configuration.md#aws-credentials)
+            * [EC2 Instance Settings](docs/cluster_profile_configuration.md#ec2-instance-settings)
+                * [For Linux](docs/cluster_profile_configuration.md#ec2-instance-settings-for-linux)
+                * [For Windows](docs/cluster_profile_configuration.md#ec2-instance-settings-for-windows)
+            * [AWS Cluster Configuration](docs/cluster_profile_configuration.md#aws-cluster-configuration)
+            * [Log Configuration](docs/cluster_profile_configuration.md#log-configuration)
+            * [Docker Registry](docs/cluster_profile_configuration.md#docker-registry)
+            * [EFS](docs/cluster_profile_configuration.md#efs)
+        * [Create elastic agent profile(s)](docs/elastic_profile_configuration.md)
+            * [container-configuration](docs/elastic_profile_configuration.md#container-configuration)
+            * [ec2-instance-configuration](docs/elastic_profile_configuration.md#ec2-instance-configuration)
+        * [Configure job to use an elastic agent profile](docs/job_configuration.md)
   * [FAQ](docs/faq.md)
   * [Troubleshooting](docs/troubleshooting.md)
 
 ## Building the code base
 
-To build the jar, run `./gradlew clean test assemble`
+To build the jar, run `./gradlew clean check assemble`
 
 ## License
 

docs/installation.md

@@ -31,7 +31,9 @@ To configure ECS using the AWS CloudFormation templates, follow these steps,
   * ```$ aws cloudformation create-stack --stack-name <stack_name> --region <region_name> --capabilities CAPABILITY_IAM --template-body file:///<path_to_json_template_file>```
 
 ---
-### Alternatively configure ECS manually (if you prefer to manually configure ECS instead of using the above CloudFormation template).
+### Alternatively configure ECS manually
+
+Listed below are the steps to be followed if you prefer to manually configure ECS instead of using the above CloudFormation template:
 
   * An ECS cluster. This cluster MUST be empty, as the plugin will manage instances and scaling in this cluster.
   * An IAM user with permissions to manage the ECS cluster. The credentials for this IAM user may be provided to the this plugin or applied via an IAM instance profile to the EC2 instance running the GoCD server. The following IAM permissions are needed