diff --git a/README.md b/README.md index 655493d2..46094f9c 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,14 @@ Prometheus recording rules and alerts. image +## Documentation -We will be leveraging [EKS Blueprints](https://github.com/aws-ia/terraform-aws-eks-blueprints) -repository to deploy the solution. +To explore the complete project documentation, please visit our [documentation site.](https://aws-observability.github.io/terraform-aws-observability-accelerator/) ## Getting started -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/) +To quickstart with a complete workflow and view Amazon EKS infrastructure dashboards, +visit the [Amazon EKS cluster monitoring documentation](https://aws-observability.github.io/terraform-aws-observability-accelerator/eks/) ## How it works diff --git a/docs/concepts.md b/docs/concepts.md index c613372c..363ca5c1 100644 --- a/docs/concepts.md +++ b/docs/concepts.md @@ -80,7 +80,7 @@ All the modules come with end-to-end deployable examples. [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. -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. +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. ## Getting started with AWS Observability services diff --git a/docs/eks.md b/docs/eks.md index 949f93d9..30dfefbf 100644 --- a/docs/eks.md +++ b/docs/eks.md @@ -18,7 +18,7 @@ and alerts to operate your cluster. ## Prerequisites -Make sure to complete the [prerequisites section](/terraform-aws-observability-accelerator/concepts/#prerequisites) +Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) before proceeding. ## Setup @@ -42,7 +42,7 @@ export TF_VAR_aws_region=xxx ### 3. Amazon EKS Cluster To run this example, you need to provide your EKS cluster name. If you don't -have a cluster ready, visit [this example](/terraform-aws-observability-accelerator/helpers/new-eks-cluster.md) +have a cluster ready, visit [this example](https://aws-observability.github.io/terraform-aws-observability-accelerator/helpers/new-eks-cluster/) first to create a new one. Specify your cluster name: diff --git a/docs/helpers/new-eks-cluster.md b/docs/helpers/new-eks-cluster.md index e3700519..4f36d22a 100644 --- a/docs/helpers/new-eks-cluster.md +++ b/docs/helpers/new-eks-cluster.md @@ -10,7 +10,7 @@ This example deploys the following: ## Prerequisites -Make sure to complete the [prerequisites section](/terraform-aws-observability-accelerator/concepts/#prerequisites) +Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) before proceeding. diff --git a/docs/workloads/java.md b/docs/workloads/java.md index c994cdb0..ca0b3139 100644 --- a/docs/workloads/java.md +++ b/docs/workloads/java.md @@ -7,7 +7,7 @@ configuration options on the cluster infrastructure. ## Prerequisites -Make sure to complete the [prerequisites section](/terraform-aws-observability-accelerator/concepts/#prerequisites) +Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) before proceeding. ## Setup @@ -31,7 +31,7 @@ export TF_VAR_aws_region=xxx ### 3. Amazon EKS Cluster To run this example, you need to provide your EKS cluster name. If you don't -have a cluster ready, visit [this example](/terraform-aws-observability-accelerator/helpers/new-eks-cluster.md) +have a cluster ready, visit [this example](https://aws-observability.github.io/terraform-aws-observability-accelerator/helpers/new-eks-cluster/) first to create a new one. Specify your cluster name: diff --git a/docs/workloads/managed-prometheus.md b/docs/workloads/managed-prometheus.md index c5ffdbcc..a843202a 100644 --- a/docs/workloads/managed-prometheus.md +++ b/docs/workloads/managed-prometheus.md @@ -7,7 +7,7 @@ workspace dashboard. ## Prerequisites -Make sure to complete the [prerequisites section](/terraform-aws-observability-accelerator/concepts/#prerequisites) +Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) before proceeding. > This example doesn't require an Amazon EKS cluster and Kubernetes tools (ex. `kubectl`). diff --git a/docs/workloads/nginx.md b/docs/workloads/nginx.md index eaa8ca52..6a41583c 100644 --- a/docs/workloads/nginx.md +++ b/docs/workloads/nginx.md @@ -8,7 +8,7 @@ configuration options on the cluster infrastructure. ## Prerequisites -Make sure to complete the [prerequisites section](/terraform-aws-observability-accelerator/concepts/#prerequisites) +Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) before proceeding. ## Setup @@ -33,7 +33,7 @@ export TF_VAR_aws_region=xxx ### 3. Amazon EKS Cluster To run this example, you need to provide your EKS cluster name. If you don't -have a cluster ready, visit [this example](/terraform-aws-observability-accelerator/helpers/new-eks-cluster.md) +have a cluster ready, visit [this example](https://aws-observability.github.io/terraform-aws-observability-accelerator/helpers/new-eks-cluster/) first to create a new one. Specify your cluster name: