From 99deb186f4ce4da5fd432a80bcf1d39a475f3052 Mon Sep 17 00:00:00 2001 From: Kritika Singh Date: Mon, 1 Jun 2020 11:33:52 +0530 Subject: [PATCH 1/2] Improve the table of contents --- README.md | 22 +++++++++++++++++++++- docs/installation.md | 4 +++- 2 files changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a1ef68e..d06e7dd 100644 --- a/README.md +++ b/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 diff --git a/docs/installation.md b/docs/installation.md index 41bb593..15ba822 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -31,7 +31,9 @@ To configure ECS using the AWS CloudFormation templates, follow these steps, * ```$ aws cloudformation create-stack --stack-name --region --capabilities CAPABILITY_IAM --template-body 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 From 5356a138800532cb76ba00aaf641b92fb4f64696 Mon Sep 17 00:00:00 2001 From: Aravind SV Date: Tue, 2 Jun 2020 10:20:37 +0100 Subject: [PATCH 2/2] Fix small typo --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d06e7dd..6ccefc9 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Table of Contents * [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) + * [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) @@ -32,8 +32,8 @@ Table of Contents * [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) + * [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)