Skip to content

Commit e73b4b9

Browse files
authored
Public doc site references update (#77)
* Update with doc site * Use full link * Fix dead links
1 parent e2de5a2 commit e73b4b9

File tree

7 files changed

+13
-12
lines changed

7 files changed

+13
-12
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,14 @@ Prometheus recording rules and alerts.
1414

1515
<img width="1501" alt="image" src="https://user-images.githubusercontent.com/10175027/193913383-94aaf4e2-58c6-4779-935b-e40528e86c03.png">
1616

17+
## Documentation
1718

18-
We will be leveraging [EKS Blueprints](https://github.com/aws-ia/terraform-aws-eks-blueprints)
19-
repository to deploy the solution.
19+
To explore the complete project documentation, please visit our [documentation site.](https://aws-observability.github.io/terraform-aws-observability-accelerator/)
2020

2121
## Getting started
2222

23-
To quickstart with a complete workflow and view Amazon EKS infrastructure dashboards, visit the [existing cluster with base and module example](./examples/existing-cluster-with-base-and-infra/)
23+
To quickstart with a complete workflow and view Amazon EKS infrastructure dashboards,
24+
visit the [Amazon EKS cluster monitoring documentation](https://aws-observability.github.io/terraform-aws-observability-accelerator/eks/)
2425

2526
## How it works
2627

docs/concepts.md

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

8181
[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.
8282

83-
You can find **workload** examples like [Amazon EKS infrstructure monitoring](/terraform-aws-observability-accelerator/workloads/eks/) or [monitoring your Amazon Managed Service for Prometheus workspace](terraform-aws-observability-accelerator/workloads/managed-prometheus/) and more.
83+
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.
8484

8585

8686
## Getting started with AWS Observability services

docs/eks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ and alerts to operate your cluster.
1818

1919
## Prerequisites
2020

21-
Make sure to complete the [prerequisites section](/terraform-aws-observability-accelerator/concepts/#prerequisites)
21+
Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites)
2222
before proceeding.
2323

2424
## Setup
@@ -42,7 +42,7 @@ export TF_VAR_aws_region=xxx
4242
### 3. Amazon EKS Cluster
4343

4444
To run this example, you need to provide your EKS cluster name. If you don't
45-
have a cluster ready, visit [this example](/terraform-aws-observability-accelerator/helpers/new-eks-cluster.md)
45+
have a cluster ready, visit [this example](https://aws-observability.github.io/terraform-aws-observability-accelerator/helpers/new-eks-cluster/)
4646
first to create a new one.
4747

4848
Specify your cluster name:

docs/helpers/new-eks-cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This example deploys the following:
1010

1111
## Prerequisites
1212

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

1616

docs/workloads/java.md

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

88
## Prerequisites
99

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

1313
## Setup
@@ -31,7 +31,7 @@ export TF_VAR_aws_region=xxx
3131
### 3. Amazon EKS Cluster
3232

3333
To run this example, you need to provide your EKS cluster name. If you don't
34-
have a cluster ready, visit [this example](/terraform-aws-observability-accelerator/helpers/new-eks-cluster.md)
34+
have a cluster ready, visit [this example](https://aws-observability.github.io/terraform-aws-observability-accelerator/helpers/new-eks-cluster/)
3535
first to create a new one.
3636

3737
Specify your cluster name:

docs/workloads/managed-prometheus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ workspace dashboard.
77

88
## Prerequisites
99

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

1313
> This example doesn't require an Amazon EKS cluster and Kubernetes tools (ex. `kubectl`).

docs/workloads/nginx.md

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

99
## Prerequisites
1010

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

1414
## Setup
@@ -33,7 +33,7 @@ export TF_VAR_aws_region=xxx
3333
### 3. Amazon EKS Cluster
3434

3535
To run this example, you need to provide your EKS cluster name. If you don't
36-
have a cluster ready, visit [this example](/terraform-aws-observability-accelerator/helpers/new-eks-cluster.md)
36+
have a cluster ready, visit [this example](https://aws-observability.github.io/terraform-aws-observability-accelerator/helpers/new-eks-cluster/)
3737
first to create a new one.
3838

3939
Specify your cluster name:

0 commit comments

Comments
 (0)