Skip to content

Commit 0b20234

Browse files
lewinkedrslewinkedrs
authored
Docs prettify (#112)
* docs admonitions * removing test files * Revert "docs admonitions" This reverts commit a76ce78. * docs improvements * removing broken links * updating diagram
1 parent 0c0ac15 commit 0b20234

File tree

9 files changed

+51
-41
lines changed

9 files changed

+51
-41
lines changed

‎docs/concepts.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ All examples in this repository require the following tools installed
1313
To run the examples, you need a set of AWS IAM permissions. You can find an example of minimum
1414
permissions required [in this file](https://github.com/aws-observability/terraform-aws-observability-accelerator/blob/main/docs/iam/min-iam-policy.json).
1515

16-
> **Note**: The policy resource is set as `*` to allow all resources, this is not a recommended practice.
17-
You should restrict instead to the ARNs when applicable.
16+
!!! warning
17+
The policy resource is set as `*` to allow all resources, this is not a recommended practice.
18+
You should restrict instead to the ARNs when applicable.
1819

1920
### Terraform states and variables
2021

@@ -27,7 +28,8 @@ You can also edit the `terraform.tfvars` files directly and deploy
2728
with `terraform apply -var-file=terraform.tfvars`. Terraform tfvars file can be useful if
2829
you need to track changes as part of a Git repository or CI/CD pipeline.
2930

30-
> **Note:** When using `tfvars` files, always be careful to not store and commit any secrets (keys, passwords, ...)
31+
!!! warning
32+
When using `tfvars` files, always be careful to not store and commit any secrets (keys, passwords, ...)
3133

3234
## Base module
3335

@@ -53,7 +55,7 @@ module "eks_observability_accelerator" {
5355
}
5456
```
5557

56-
You can optionally reuse an existing Amazon Managed Servce for Prometheus Workspace:
58+
You can optionally reuse an existing Amazon Managed Service for Prometheus Workspace:
5759

5860
```hcl
5961
module "eks_observability_accelerator" {
@@ -89,7 +91,9 @@ All the modules come with end-to-end deployable examples.
8991

9092
[Examples](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/examples) put modules together in a ready to deploy terraform configuration as a starting point. With little to no configuration, you can run `terraform apply` and use the deployed resources on your AWS Account.
9193

92-
You can find **workload** examples like [Amazon EKS infrstructure monitoring](https://aws-observability.github.io/terraform-aws-observability-accelerator/eks/) or [monitoring your Amazon Managed Service for Prometheus workspace](https://aws-observability.github.io/terraform-aws-observability-accelerator/workloads/managed-prometheus/) and more.
94+
You can find **workload** examples like [Amazon EKS infrastructure monitoring](https://aws-observability.github.io/terraform-aws-observability-accelerator/eks/) or [monitoring your Amazon Managed Service for Prometheus workspace](https://aws-observability.github.io/terraform-aws-observability-accelerator/workloads/managed-prometheus/) and more.
95+
96+
![example diagram](images/example-diagram.svg)
9397

9498

9599
## Getting started with AWS Observability services

‎docs/eks/destroy.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@
33
If you leave this stack running, you will continue to incur charges. To remove all resources
44
created by Terraform, [refresh your Grafana API key](https://aws-observability.github.io/terraform-aws-observability-accelerator/eks/#6-grafana-api-key) and run the command below.
55

6-
Be careful, this command will removing everything created by Terraform. If you wish
7-
to keep your Amazon Managed Grafana or Amazon Managed Service for Prometheus workspaces. Remove them
8-
from your terraform state before running the destroy command.
6+
!!! warning
7+
Be careful, this command will removing everything created by Terraform. If you wish
8+
to keep your Amazon Managed Grafana or Amazon Managed Service for Prometheus workspaces. Remove them
9+
from your terraform state before running the destroy command.
910

1011
```bash
1112
terraform destroy

‎docs/eks/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ on your EKS cluster.
2222

2323
## Prerequisites
2424

25-
Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites)
26-
before proceeding.
25+
!!! note
26+
Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) before proceeding.
2727

2828
## Setup
2929

@@ -132,8 +132,8 @@ Open the Amazon Managed Service for Prometheus console and view the details of y
132132

133133
<img width="1629" alt="image" src="https://user-images.githubusercontent.com/10175027/189301297-4865e75d-2d71-434f-b5d0-9750b3533632.png">
134134

135-
136-
To setup your alert receiver, with Amazon SNS, follow [this documentation](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-alertmanager-receiver.html)
135+
!!! note
136+
To setup your alert receiver, with Amazon SNS, follow [this documentation](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-alertmanager-receiver.html)
137137

138138

139139
## Custom metrics collection

‎docs/helpers/new-eks-cluster.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Creating a new Amazon EKS cluster with VPC
22

3-
> Note: This example is a subset from [this EKS Blueprint example](https://github.com/aws-ia/terraform-aws-eks-blueprints/tree/main/examples/eks-cluster-with-new-vpc)
3+
!!! note
4+
This example is a subset from [this EKS Blueprint example](https://github.com/aws-ia/terraform-aws-eks-blueprints/tree/main/examples/eks-cluster-with-new-vpc)
45

56
This example deploys the following:
67

@@ -10,8 +11,8 @@ This example deploys the following:
1011

1112
## Prerequisites
1213

13-
Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites)
14-
before proceeding.
14+
!!! note
15+
Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) before proceeding.
1516

1617

1718
## Setup

‎docs/images/example-diagram.svg

Lines changed: 1 addition & 0 deletions
Loading

‎docs/index.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Welcome to the AWS Observability Accelerator for Terraform!
44

55
The AWS Observability accelerator is a set of Terraform modules to help you
6-
configure Observability for your container workloads and environemnts with AWS
6+
configure Observability for your container workloads and environments with AWS
77
Observability services. This project proposes a core module to bootstrap
88
your Amazon EKS cluster with the AWS Distro for OpenTelemetry (ADOT) Operator for EKS,
99
Amazon Managed Service for Prometheus, Amazon Managed Grafana.
@@ -23,27 +23,28 @@ dashboards and alerts for monitoring:
2323
- Java/JMX workloads (running on Amazon EKS)
2424
- Amazon Managed Service for Prometheus workspaces with Amazon CloudWatch
2525

26-
These modules can be directly configured in your exisiting Terraform configurations or ready
26+
These modules can be directly configured in your existing Terraform configurations or ready
2727
to be deployed in our packaged
2828
[examples](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/examples)
2929

30-
We have supporting examples for quick setup such as:
30+
!!! tip
31+
We have supporting examples for quick setup such as:
3132

32-
- Creating an empty Amazon EKS cluster and a VPC
33-
- Creating and configure an Amazon Managed Grafana workspace with SSO
33+
- Creating an empty Amazon EKS cluster and a VPC
34+
- Creating and configure an Amazon Managed Grafana workspace with SSO
3435

3536
## Motivation
3637

37-
To gain deep visibility into your workloads and environements, AWS proposes a
38-
set of secure, scalabale, highly available, production-grade managed open
38+
To gain deep visibility into your workloads and environments, AWS proposes a
39+
set of secure, scalable, highly available, production-grade managed open
3940
source services such as Amazon Managed Service for Prometheus, Amazon Managed
4041
Grafana and Amazon OpenSearch.
4142

4243
AWS customers have asked for best-practices and guidance to collect metrics, logs
4344
and traces from their containerized applications and microservices with ease of
4445
deployment. Customers can use the AWS Observability Accelerator to configure their
4546
metrics collection, leveraging [AWS Distro for OpenTelemetry](https://aws-otel.github.io/),
46-
to have opinionated dashoards and alerts available in only minutes.
47+
to have opinionated dashboards and alerts available in only minutes.
4748

4849

4950
## Support & Feedback

‎docs/workloads/java.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ configuration options on the cluster infrastructure.
77

88
## Prerequisites
99

10-
Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites)
11-
before proceeding.
10+
!!! note
11+
Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) before proceeding.
1212

1313
## Setup
1414

@@ -118,8 +118,8 @@ Open the Amazon Managed Service for Prometheus console and view the details of y
118118

119119
<img width="1314" alt="image" src="https://user-images.githubusercontent.com/97046295/194904104-09a28577-d149-478e-b0a1-dc21cb7effc1.png">
120120

121-
122-
To setup your alert receiver, with Amazon SNS, follow [this documentation](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-alertmanager-receiver.html)
121+
!!! note
122+
To setup your alert receiver, with Amazon SNS, follow [this documentation](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-alertmanager-receiver.html)
123123

124124

125125
## Deploy an Example Java Application
@@ -178,9 +178,10 @@ tomcat-traffic-generator 1/1 Running 0 11s
178178
If you leave this stack running, you will continue to incur charges. To remove all resources
179179
created by Terraform, [refresh your Grafana API key](#6-grafana-api-key) and run the command below.
180180

181-
Be careful, this command will removing everything created by Terraform. If you wish
182-
to keep your Amazon Managed Grafana or Amazon Managed Service for Prometheus workspaces. Remove them
183-
from your terraform state before running the destroy command.
181+
!!! warning
182+
Be careful, this command will removing everything created by Terraform. If you wish
183+
to keep your Amazon Managed Grafana or Amazon Managed Service for Prometheus workspaces. Remove them
184+
from your terraform state before running the destroy command.
184185

185186
```bash
186187
terraform destroy

0 commit comments

Comments
 (0)