From 96fd88be58bc4157e54245dff9cf51434c7eb99a Mon Sep 17 00:00:00 2001 From: Rodrigue Koffi Date: Mon, 20 Feb 2023 18:56:20 +0100 Subject: [PATCH] Update docs links (#122) * Update links in doc * Update broken link * Apply consistency --- README.md | 2 +- docs/eks/destroy.md | 3 ++- docs/eks/index.md | 2 +- docs/eks/java.md | 4 ++-- docs/eks/nginx.md | 4 ++-- 5 files changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 36dd7f8..6e9b803 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ v2+ releases introduces couple of breaking changes compared to previous versions - `modules/workloads/infra` module moves to `modules/eks-monitoring` - All EKS configuration options moves from the base module to the `eks-monitoring` module -- All EKS workload modules `modules/workloads/{java,nginx}` merge into `eks-monitoring` as configuration options (patterns), see [examples](./examples) to provide a more complete visiblity. +- All EKS workload modules `modules/workloads/{java,nginx}` merge into `eks-monitoring` as configuration options (patterns), see [examples](./examples) to provide a more complete visiblity - All examples have been updated to reflect these changes ### Base Module diff --git a/docs/eks/destroy.md b/docs/eks/destroy.md index 389fcc8..f9f5c5a 100644 --- a/docs/eks/destroy.md +++ b/docs/eks/destroy.md @@ -20,4 +20,5 @@ terraform state rm "module.eks_observability_accelerator.aws_prometheus_workspac ``` !!! note - To view all the features proposed by this module, visit the [module documentation](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/modules/workloads/infra). + To view all the features proposed by this module, + visit the [module documentation](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/modules/eks-monitoring). diff --git a/docs/eks/index.md b/docs/eks/index.md index e3e9c79..af0e59a 100644 --- a/docs/eks/index.md +++ b/docs/eks/index.md @@ -2,7 +2,7 @@ This example demonstrates how to monitor your Amazon Elastic Kubernetes Service (Amazon EKS) cluster with the Observability Accelerator's EKS -[infrastructure module](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/feat/modules-composition/modules/eks-monitoring). +[infrastructure module](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/modules/eks-monitoring). Monitoring Amazon Elastic Kubernetes Service (Amazon EKS) for metrics has two categories: the control plane and the Amazon EKS nodes (with Kubernetes objects). diff --git a/docs/eks/java.md b/docs/eks/java.md index c863970..b4624d9 100644 --- a/docs/eks/java.md +++ b/docs/eks/java.md @@ -2,7 +2,7 @@ !!! note Since v2.x, Java based applications monitoring on EKS has been merged within - the [eks-monitoring module](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/feat/modules-composition/modules/eks-monitoring) + the [eks-monitoring module](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/modules/eks-monitoring) to allow visibility both on the cluster and the workloads, [#59](https://github.com/aws-observability/terraform-aws-observability-accelerator/issues/59). In addition to EKS infrastructure monitoring, the current example provides @@ -24,7 +24,7 @@ module "eks_monitoring" { } ``` -You can further customize the Java pattern by providing `java_config` [options](https://github.com/aws-observability/terraform-aws-observability-accelerator/blob/feat/modules-composition/modules/eks-monitoring/README.md#input_java_config). +You can further customize the Java pattern by providing `java_config` [options](https://github.com/aws-observability/terraform-aws-observability-accelerator/blob/main/modules/eks-monitoring/README.md#input_java_config). ### 2. Grafana API key diff --git a/docs/eks/nginx.md b/docs/eks/nginx.md index dca713b..ecf5b00 100644 --- a/docs/eks/nginx.md +++ b/docs/eks/nginx.md @@ -2,7 +2,7 @@ !!! note Since v2.x, NGINX based applications monitoring on EKS has been merged within - the [eks-monitoring module](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/feat/modules-composition/modules/eks-monitoring) + the [eks-monitoring module](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/modules/eks-monitoring) to allow visibility both on the cluster and the workloads, [#59](https://github.com/aws-observability/terraform-aws-observability-accelerator/issues/59). In addition to EKS infrastructure monitoring, the current example provides @@ -24,7 +24,7 @@ module "eks_monitoring" { } ``` -You can further customize the NGINX pattern by providing `nginx_config` [options](https://github.com/aws-observability/terraform-aws-observability-accelerator/blob/feat/modules-composition/modules/eks-monitoring/README.md#input_nginx_config). +You can further customize the NGINX pattern by providing `nginx_config` [options](https://github.com/aws-observability/terraform-aws-observability-accelerator/blob/main/modules/eks-monitoring/README.md#input_nginx_config). ### 2. Grafana API key