Skip to content

Commit d4039b4

Browse files
committed
contributing replace back to toc with top
1 parent 2c49856 commit d4039b4

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

CONTRIBUTING.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ If you've already completed these steps or you aren't making Terraform changes,
3434
- Agree to the AWS Customer Agreement and Service Terms, complete the registration by clicking `"Create Account and Continue"`, verify your phone number via text or call, confirm your email address following the instructions in the confirmation email, and finally sign in to access your new AWS account using your email and password.
3535
- Follow this [video guide](https://youtu.be/CjKhQoYeR4Q?si=78GhlDLV5zZu8qwh) for deeper explanations.
3636

37-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
37+
<sub>[Back to Top](#)</sub>
3838
***
3939

4040
### **Login as root user & setup MFA**
@@ -47,7 +47,7 @@ If you've already completed these steps or you aren't making Terraform changes,
4747

4848
**Note:** Select the `us-west-2` region. It's not required for managing IAM resources, as they are global. However, it's advisable since our other resources are in the same region.
4949

50-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
50+
<sub>[Back to Top](#)</sub>
5151
***
5252

5353
## **Setting up IAM and AWS CLI**
@@ -76,7 +76,7 @@ If you've already completed these steps or you aren't making Terraform changes,
7676
```
7777
**Note:** Password length must be 20 characters
7878

79-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
79+
<sub>[Back to Top](#)</sub>
8080
***
8181
- ### **Create an IAM Group**
8282

@@ -85,7 +85,7 @@ If you've already completed these steps or you aren't making Terraform changes,
8585
```bash
8686
aws iam create-group --group-name AdminGroup
8787
```
88-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
88+
<sub>[Back to Top](#)</sub>
8989
***
9090
- ### **Attach IAM user to IAM group**
9191

@@ -99,7 +99,7 @@ If you've already completed these steps or you aren't making Terraform changes,
9999
```bash
100100
aws iam add-user-to-group --group-name AdminGroup --user-name octocat
101101
```
102-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
102+
<sub>[Back to Top](#)</sub>
103103
***
104104
- ### **Attach `AdministratorAccess` policy to IAM group**
105105

@@ -108,7 +108,7 @@ If you've already completed these steps or you aren't making Terraform changes,
108108
```bash
109109
aws iam attach-group-policy --policy-arn arn:aws:iam::aws:policy/AdministratorAccess --group-name AdminGroup
110110
```
111-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
111+
<sub>[Back to Top](#)</sub>
112112
***
113113
- Log in as the newly created user instead of continuing to log in as the root user.
114114
- ### **Generating Access Keys for AWS CLI**
@@ -123,13 +123,13 @@ If you've already completed these steps or you aren't making Terraform changes,
123123
```bash
124124
nano access_key.json
125125
```
126-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
126+
<sub>[Back to Top](#)</sub>
127127
***
128128
The below steps must be completed in order to authenticate to AWS locally via the command line interface (CLI):
129129
- [Install AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
130130
- [Set up the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-quickstart.html)
131131
132-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
132+
<sub>[Back to Top](#)</sub>
133133
***
134134
135135
### **Creating Backend State**
@@ -179,21 +179,21 @@ aws dynamodb create-table \
179179
--billing-mode PAY_PER_REQUEST
180180
```
181181

182-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
182+
<sub>[Back to Top](#)</sub>
183183
***
184184

185185
### **Installing Terraform**
186186

187187
Use the [Official HashiCorp install instructions](https://developer.hashicorp.com/terraform/install) for installing terraform.
188188

189-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
189+
<sub>[Back to Top](#)</sub>
190190
***
191191

192192
### **Installing Terraform docs**
193193

194194
Follow the Terraform docs [installation guide](https://terraform-docs.io/user-guide/installation/)
195195

196-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
196+
<sub>[Back to Top](#)</sub>
197197
***
198198

199199
## **Clone the repository**
@@ -220,7 +220,7 @@ You should now have a new folder in your `hackforla` folder called `devops-secur
220220
cd devops-security
221221
```
222222

223-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
223+
<sub>[Back to Top](#)</sub>
224224
***
225225

226226
### **Create a new branch where you will work on your issue**
@@ -246,7 +246,7 @@ git checkout -b update-contributing-guide-15
246246

247247
When you've finished working on your issue, follow the steps below to prepare your changes to push to your repository.
248248
249-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
249+
<sub>[Back to Top](#)</sub>
250250
***
251251
252252
### **Creating Local tfvars file**
@@ -263,7 +263,7 @@ encrypt = true
263263
264264
Remember to match these values to the ones in your backend state (and replace USERNAME with your username)
265265
266-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
266+
<sub>[Back to Top](#)</sub>
267267
***
268268
269269
### **Terraform Setup and Execution Instructions**
@@ -297,7 +297,7 @@ terraform apply
297297
terraform destroy
298298
```
299299
300-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
300+
<sub>[Back to Top](#)</sub>
301301
***
302302
303303
### Generate Terraform Docs
@@ -311,7 +311,7 @@ cd terraform # or other directory
311311
terraform-docs -c .terraform.docs.yml .
312312
```
313313
314-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
314+
<sub>[Back to Top](#)</sub>
315315
***
316316
317317
### **Submitting changes via git and opening a PR**
@@ -336,5 +336,5 @@ git add terraform/aws-users.tf
336336
```
337337
- Lastly open a PR to merge your changes into the `main` branch.
338338
339-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
339+
<sub>[Back to Top](#)</sub>
340340
***

0 commit comments

Comments
 (0)