From 72cd58cee13f59a89e84e3d5fba7cf794a379d06 Mon Sep 17 00:00:00 2001 From: Doyoon Kim Date: Fri, 17 Nov 2023 13:32:10 -0800 Subject: [PATCH] Docs: move envvar section and fix links (#522) * Docs: move envvar section and fix links --- docs/guides/deploy.md | 5 +---- docs/{concepts => guides}/environment.md | 0 docs/guides/getstarted.md | 2 +- mkdocs.yml | 2 +- 4 files changed, 3 insertions(+), 6 deletions(-) rename docs/{concepts => guides}/environment.md (100%) diff --git a/docs/guides/deploy.md b/docs/guides/deploy.md index ea143169..36a54861 100644 --- a/docs/guides/deploy.md +++ b/docs/guides/deploy.md @@ -131,14 +131,11 @@ Alternatively, you can manually provide configuration variables when installing ## Controller Installation -1. Run either `kubectl` or `helm` to deploy the controller. Check [Environment Variables](../concepts/environment.md) for detailed explanation of each configuration option. - +1. Run either `kubectl` or `helm` to deploy the controller. Check [Environment Variables](../guides/environment.md) for detailed explanation of each configuration option. ```bash kubectl apply -f examples/deploy-v0.0.18.yaml ``` - or - ```bash # login to ECR aws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws diff --git a/docs/concepts/environment.md b/docs/guides/environment.md similarity index 100% rename from docs/concepts/environment.md rename to docs/guides/environment.md diff --git a/docs/guides/getstarted.md b/docs/guides/getstarted.md index ffe1b5af..cce8d070 100644 --- a/docs/guides/getstarted.md +++ b/docs/guides/getstarted.md @@ -6,7 +6,7 @@ The first part of this section provides an example of setting up of service-to-s The second section extends that example by creating another inventory service on a second cluster on a different VPC, and spreading traffic to that service across the two clusters and VPCs. Both clusters are created using `eksctl`, with both clusters created from the same account by the same cluster admin. -Using these examples as a foundation, see the [Configuration](../concepts/index.md) section for ways to further configure service-to-service communications. +Using these examples as a foundation, see the [Concepts](../concepts/overview.md) section for ways to further configure service-to-service communications. **NOTE**: You can get the yaml files used on this page by cloning the [AWS Gateway API Controller](https://github.com/aws/aws-application-networking-k8s) repository. diff --git a/mkdocs.yml b/mkdocs.yml index 749c85f6..9ea85cc2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -10,9 +10,9 @@ nav: - User Guides: - Quick Start: guides/deploy.md - Basic Setup: guides/getstarted.md + - Configuration: guides/environment.md - Concepts: - Design Overview: concepts/overview.md - - Environment Variables: concepts/environment.md - TLS: concepts/https.md - Custom Domain Name: concepts/custom-domain-name.md - GRPC: concepts/grpc.md