Skip to content

Commit

Permalink
Public doc site references update (#77)
Browse files Browse the repository at this point in the history
* Update with doc site

* Use full link

* Fix dead links
  • Loading branch information
bonclay7 authored Jan 10, 2023
1 parent e2de5a2 commit e73b4b9
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 12 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,14 @@ Prometheus recording rules and alerts.

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

## 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

Expand Down
2 changes: 1 addition & 1 deletion docs/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/eks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/helpers/new-eks-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
4 changes: 2 additions & 2 deletions docs/workloads/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/workloads/managed-prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`).
Expand Down
4 changes: 2 additions & 2 deletions docs/workloads/nginx.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down

0 comments on commit e73b4b9

Please sign in to comment.