Fixes typos and markdown syntax in the documentation (#217)

* Fix typos and codeblocks

* Fix codeblocks syntax
This commit is contained in:
Bruno Padilha
2023-08-11 11:53:04 -03:00
committed by GitHub
parent aa7b1f38b2
commit d832c285f8
2 changed files with 7 additions and 7 deletions
+1 -1
View File
@@ -118,7 +118,7 @@ All the modules come with end-to-end deployable examples.
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. 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.
``` mermaid ```mermaid
classDiagram classDiagram
Example <|-- Base Module Example <|-- Base Module
Example <|-- Workload Module Example <|-- Workload Module
+6 -6
View File
@@ -46,13 +46,13 @@ cluster.
=== "amd64 linux" === "amd64 linux"
``` console ```console
docker build -t go-sample-app . docker build -t go-sample-app .
``` ```
=== "cross platform build" === "cross platform build"
``` bash ```bash
docker buildx build -t go-sample-app . --platform=linux/amd64 docker buildx build -t go-sample-app . --platform=linux/amd64
``` ```
@@ -61,7 +61,7 @@ cluster.
=== "using docker" === "using docker"
``` console ```console
export ECR_REPOSITORY_URI=$(aws ecr create-repository --repository go-sample-app --query repository.repositoryUri --output text) export ECR_REPOSITORY_URI=$(aws ecr create-repository --repository go-sample-app --query repository.repositoryUri --output text)
aws ecr get-login-password --region $AWS_REGION | docker login --username AWS --password-stdin $ECR_REPOSITORY_URI aws ecr get-login-password --region $AWS_REGION | docker login --username AWS --password-stdin $ECR_REPOSITORY_URI
docker tag go-sample-app:latest "${ECR_REPOSITORY_URI}:latest" docker tag go-sample-app:latest "${ECR_REPOSITORY_URI}:latest"
@@ -72,7 +72,7 @@ cluster.
## Deploying on Amazon EKS ## Deploying on Amazon EKS
``` yaml title="eks.yaml" linenums="1" ```yaml title="eks.yaml" linenums="1"
apiVersion: apps/v1 apiVersion: apps/v1
kind: Deployment kind: Deployment
metadata: metadata:
@@ -182,8 +182,8 @@ of traces occured in the selected timeframe.
<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"> <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">
You can add the service map to a dashbaord, for example a service focused You can add the service map to a dashboard, for example a service focused
dashbaord. You can click on any of the traces to view a node map and the traces dashboard. You can click on any of the traces to view a node map and the traces
details. details.
There is a button that can take you the CloudWatch console to view the same There is a button that can take you the CloudWatch console to view the same