Skip to content

Commit d832c28

Browse files
authored
Fixes typos and markdown syntax in the documentation (#217)
* Fix typos and codeblocks * Fix codeblocks syntax
1 parent aa7b1f3 commit d832c28

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ All the modules come with end-to-end deployable examples.
118118

119119
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.
120120

121-
``` mermaid
121+
```mermaid
122122
classDiagram
123123
Example <|-- Base Module
124124
Example <|-- Workload Module

docs/eks/tracing.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ cluster.
4646

4747
=== "amd64 linux"
4848

49-
``` console
49+
```console
5050
docker build -t go-sample-app .
5151
```
5252

5353
=== "cross platform build"
5454

55-
``` bash
55+
```bash
5656
docker buildx build -t go-sample-app . --platform=linux/amd64
5757
```
5858

@@ -61,7 +61,7 @@ cluster.
6161

6262
=== "using docker"
6363

64-
``` console
64+
```console
6565
export ECR_REPOSITORY_URI=$(aws ecr create-repository --repository go-sample-app --query repository.repositoryUri --output text)
6666
aws ecr get-login-password --region $AWS_REGION | docker login --username AWS --password-stdin $ECR_REPOSITORY_URI
6767
docker tag go-sample-app:latest "${ECR_REPOSITORY_URI}:latest"
@@ -72,7 +72,7 @@ cluster.
7272
## Deploying on Amazon EKS
7373

7474

75-
``` yaml title="eks.yaml" linenums="1"
75+
```yaml title="eks.yaml" linenums="1"
7676
apiVersion: apps/v1
7777
kind: Deployment
7878
metadata:
@@ -182,8 +182,8 @@ of traces occured in the selected timeframe.
182182

183183
<img width="1721" alt="Screenshot 2023-07-20 at 21 42 30" src="https://github.com/aws-observability/terraform-aws-observability-accelerator/assets/10175027/bd992a77-05fb-47d2-8ed4-af05d96e951d">
184184

185-
You can add the service map to a dashbaord, for example a service focused
186-
dashbaord. You can click on any of the traces to view a node map and the traces
185+
You can add the service map to a dashboard, for example a service focused
186+
dashboard. You can click on any of the traces to view a node map and the traces
187187
details.
188188

189189
There is a button that can take you the CloudWatch console to view the same

0 commit comments

Comments
 (0)