From 77cbc959d946f5b558f0122e341bc90aa65e73c8 Mon Sep 17 00:00:00 2001 From: Hope Ngerebara Date: Wed, 15 Jan 2020 11:36:53 +0100 Subject: [PATCH 1/2] fix broken links --- CONTRIBUTING.md | 14 +++++++------- modules/vault-cluster/README.md | 6 +++--- modules/vault-elb/README.md | 4 ++-- modules/vault-security-group-rules/README.md | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eaa5212b..4565f5ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,12 +3,12 @@ Contributions to this Module are very welcome! We follow a fairly standard [pull request process](https://help.github.com/articles/about-pull-requests/) for contributions, subject to the following guidelines: -1. [File a GitHub issue](#file-a-github-issue) -1. [Update the documentation](#update-the-documentation) -1. [Update the tests](#update-the-tests) -1. [Update the code](#update-the-code) -1. [Create a pull request](#create-a-pull-request) -1. [Merge and release](#merge-and-release) + 1. [File a GitHub issue](#file-a-github-issue) + 2. [Update the documentation](#update-the-documentation) + 3. [Update the tests](#update-the-tests) + 4. [Update the code](#update-the-code) + 5. [Create a pull request](#create-a-pull-request) + 6. [Merge and release](#merge-and-release) ## File a GitHub issue @@ -29,7 +29,7 @@ We also recommend updating the automated tests *before* updating any code (see [ Development](https://en.wikipedia.org/wiki/Test-driven_development)). That means you add or update a test case, verify that it's failing with a clear error message, and *then* make the code changes to get that test to pass. This ensures the tests stay up to date and verify all the functionality in this Module, including whatever new -functionality you're adding in your contribution. Check out the [tests](https://github.com/hashicorp/terraform-aws-vault/tree/master/tests) folder for instructions on running the +functionality you're adding in your contribution. Check out the [tests](https://github.com/hashicorp/terraform-aws-vault/tree/master/test) folder for instructions on running the automated tests. ## Update the code diff --git a/modules/vault-cluster/README.md b/modules/vault-cluster/README.md index ff832488..7b4c4ee5 100644 --- a/modules/vault-cluster/README.md +++ b/modules/vault-cluster/README.md @@ -44,7 +44,7 @@ module "vault_cluster" { } ] - # ... See vars.tf for the other parameters you must define for the vault-cluster module + # ... See variables.tf for the other parameters you must define for the vault-cluster module } ``` @@ -66,7 +66,7 @@ Note the following parameters: run Vault. The `run-vault` script is one of the scripts installed by the [install-vault](https://github.com/hashicorp/terraform-aws-vault/tree/master/modules/install-vault) module. -You can find the other parameters in [vars.tf](vars.tf). +You can find the other parameters in [variables.tf](variables.tf). Check out the [root example](https://github.com/hashicorp/terraform-aws-vault/tree/master/examples/root-example) and [vault-cluster-private](https://github.com/hashicorp/terraform-aws-vault/tree/master/examples/vault-cluster-private) examples for working sample code. @@ -437,7 +437,7 @@ This module attaches a security group to each EC2 Instance that allows inbound r [CIDR blocks](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) that will be allowed access. You can use the `allowed_ssh_security_group_ids` parameter to control the list of source Security Groups that will be allowed access. Note that all the ports mentioned above are configurable via the `xxx_port` variables (e.g. `api_port`). See -[vars.tf](vars.tf) for the full list. +[variables.tf](variables.tf) for the full list. diff --git a/modules/vault-elb/README.md b/modules/vault-elb/README.md index 09407aef..9dc6564b 100644 --- a/modules/vault-elb/README.md +++ b/modules/vault-elb/README.md @@ -23,7 +23,7 @@ module "vault_elb" { vault_asg_name = "${module.vault_cluster.asg_name}" - # ... See vars.tf for the other parameters you must define for the vault-cluster module + # ... See variables.tf for the other parameters you must define for the vault-cluster module } # Configure the Vault cluster to use the ELB @@ -47,7 +47,7 @@ Note the following parameters: [vault-cluster module](https://github.com/hashicorp/terraform-aws-vault/tree/master/modules/vault-cluster) tells it to register each server with the ELB when it is booting. -You can find the other parameters in [vars.tf](vars.tf). +You can find the other parameters in [variables.tf](variables.tf). Check out the [root example](https://github.com/hashicorp/terraform-aws-vault/tree/master/examples/root-example) for working sample code. diff --git a/modules/vault-security-group-rules/README.md b/modules/vault-security-group-rules/README.md index d36f18fc..48df1258 100644 --- a/modules/vault-security-group-rules/README.md +++ b/modules/vault-security-group-rules/README.md @@ -43,6 +43,6 @@ Note the following parameters: * `security_group_id`: Use this parameter to specify the ID of the security group to which the rules in this module should be added. -You can find the other parameters in [vars.tf](vars.tf). +You can find the other parameters in [variables.tf](variables.tf). Check out the [vault-cluster module](https://github.com/hashicorp/terraform-aws-vault/tree/master/modules/vault-cluster) for example usage. From aafb8fed1617f8d83463618d1fc6e54703f85bda Mon Sep 17 00:00:00 2001 From: Hope Ngerebara Date: Fri, 17 Jan 2020 00:14:37 +0100 Subject: [PATCH 2/2] fix more links and revert toc items --- CONTRIBUTING.md | 12 ++++++------ examples/vault-auto-unseal/README.md | 2 +- examples/vault-cluster-private/README.md | 2 +- examples/vault-ec2-auth/README.md | 2 +- examples/vault-s3-backend/README.md | 2 +- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4565f5ab..ea1ca5c8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,12 +3,12 @@ Contributions to this Module are very welcome! We follow a fairly standard [pull request process](https://help.github.com/articles/about-pull-requests/) for contributions, subject to the following guidelines: - 1. [File a GitHub issue](#file-a-github-issue) - 2. [Update the documentation](#update-the-documentation) - 3. [Update the tests](#update-the-tests) - 4. [Update the code](#update-the-code) - 5. [Create a pull request](#create-a-pull-request) - 6. [Merge and release](#merge-and-release) +1. [File a GitHub issue](#file-a-github-issue) +1. [Update the documentation](#update-the-documentation) +1. [Update the tests](#update-the-tests) +1. [Update the code](#update-the-code) +1. [Create a pull request](#create-a-pull-request) +1. [Merge and release](#merge-and-release) ## File a GitHub issue diff --git a/examples/vault-auto-unseal/README.md b/examples/vault-auto-unseal/README.md index 829e15e3..770b559d 100644 --- a/examples/vault-auto-unseal/README.md +++ b/examples/vault-auto-unseal/README.md @@ -38,7 +38,7 @@ even if you immediately delete it. Make sure to note down the ID of the AMI. 1. Install [Terraform][terraform]. 1. [Create an AWS KMS key][key_creation]. Take note of the key alias. -1. Open `vars.tf`, set the environment variables specified at the top of the file, +1. Open `variables.tf`, set the environment variables specified at the top of the file, and fill in any other variables that don't have a default. Put the AMI ID you previously took note into the `ami_id` variable and the KMS key alias into `auto_unseal_kms_key_alias`. diff --git a/examples/vault-cluster-private/README.md b/examples/vault-cluster-private/README.md index 79984ee4..ca0abbac 100644 --- a/examples/vault-cluster-private/README.md +++ b/examples/vault-cluster-private/README.md @@ -42,7 +42,7 @@ To deploy a Vault Cluster: example](https://github.com/hashicorp/terraform-aws-vault/tree/master/examples/vault-consul-ami) documentation for instructions. Make sure to note down the ID of the AMI. 1. Install [Terraform](https://www.terraform.io/). -1. Open `vars.tf`, set the environment variables specified at the top of the file, and fill in any other variables that +1. Open `variables.tf`, set the environment variables specified at the top of the file, and fill in any other variables that don't have a default. If you built a custom AMI, put the AMI ID into the `ami_id` variable. Otherwise, one of our public example AMIs will be used by default. These AMIs are great for learning/experimenting, but are NOT recommended for production use. diff --git a/examples/vault-ec2-auth/README.md b/examples/vault-ec2-auth/README.md index a7811fc4..29af1121 100644 --- a/examples/vault-ec2-auth/README.md +++ b/examples/vault-ec2-auth/README.md @@ -38,7 +38,7 @@ of the Vault nodes. 1. Build a Vault and Consul AMI. See the [vault-consul-ami example][vault_consul_ami] documentation for instructions. Make sure to note down the ID of the AMI. 1. Install [Terraform](https://www.terraform.io/). -1. Open `vars.tf`, set the environment variables specified at the top of the file, and fill in any other variables that +1. Open `variables.tf`, set the environment variables specified at the top of the file, and fill in any other variables that don't have a default. Put the AMI ID you previously took note into the `ami_id` variable. 1. Run `terraform init`. 1. Run `terraform apply`. diff --git a/examples/vault-s3-backend/README.md b/examples/vault-s3-backend/README.md index 30d70648..e37fbaec 100644 --- a/examples/vault-s3-backend/README.md +++ b/examples/vault-s3-backend/README.md @@ -36,7 +36,7 @@ To deploy a Vault Cluster: example](https://github.com/hashicorp/terraform-aws-vault/tree/master/examples/vault-consul-ami) documentation for instructions. Make sure to note down the ID of the AMI. 1. Install [Terraform](https://www.terraform.io/). -1. Open `vars.tf`, set the environment variables specified at the top of the file, and fill in any other variables that +1. Open `variables.tf`, set the environment variables specified at the top of the file, and fill in any other variables that don't have a default. If you built a custom AMI, put the AMI ID into the `ami_id` variable. Otherwise, one of our public example AMIs will be used by default. These AMIs are great for learning/experimenting, but are NOT recommended for production use.