From 5fd955dfab9722e072f13f6858b76f756aeaf7b3 Mon Sep 17 00:00:00 2001 From: Paul Glass Date: Mon, 13 Dec 2021 17:25:28 -0600 Subject: [PATCH] docs: Flatten ECS "Getting Started" navigation --- website/content/docs/ecs/enterprise.mdx | 4 +-- website/content/docs/ecs/index.mdx | 2 +- .../docs/ecs/{get-started => }/install.mdx | 2 +- .../migrate-existing-tasks.mdx | 2 +- .../production-installation.mdx | 4 +-- .../ecs/{get-started => }/requirements.mdx | 0 website/data/docs-nav-data.json | 33 ++++++++----------- 7 files changed, 21 insertions(+), 26 deletions(-) rename website/content/docs/ecs/{get-started => }/install.mdx (98%) rename website/content/docs/ecs/{get-started => }/migrate-existing-tasks.mdx (96%) rename website/content/docs/ecs/{get-started => }/production-installation.mdx (95%) rename website/content/docs/ecs/{get-started => }/requirements.mdx (100%) diff --git a/website/content/docs/ecs/enterprise.mdx b/website/content/docs/ecs/enterprise.mdx index e2e15a029a..b181b5e130 100644 --- a/website/content/docs/ecs/enterprise.mdx +++ b/website/content/docs/ecs/enterprise.mdx @@ -27,10 +27,10 @@ module "my_task" { ## Licensing -~> **Warning:** Consul Enterprise is currently only fully supported when [ACLs are enabled](/docs/ecs/get-started/production-installation#deploy-acl-controller). +~> **Warning:** Consul Enterprise is currently only fully supported when [ACLs are enabled](/docs/ecs/production-installation#deploy-acl-controller). Consul Enterprise [requires a license](/docs/enterprise/license/overview). If running -Consul on ECS with [ACLs enabled](/docs/ecs/get-started/production-installation#deploy-acl-controller), the license +Consul on ECS with [ACLs enabled](/docs/ecs/production-installation#deploy-acl-controller), the license will be automatically pulled down from Consul servers. Currently there is no capability for specifying the license when ACLs are disabled so if you wish to diff --git a/website/content/docs/ecs/index.mdx b/website/content/docs/ecs/index.mdx index 27a44bef59..27019c3fbb 100644 --- a/website/content/docs/ecs/index.mdx +++ b/website/content/docs/ecs/index.mdx @@ -27,7 +27,7 @@ There are several ways to get started with Consul with ECS. * The [Consul with Dev Server on Fargate](https://registry.terraform.io/modules/hashicorp/consul-ecs/aws/latest/examples/dev-server-fargate) example installation deploys a sample application in ECS using the Fargate launch type. * The [Consul with Dev Server on EC2](https://registry.terraform.io/modules/hashicorp/consul-ecs/aws/latest/examples/dev-server-ec2) example installation deploys a sample application in ECS using the EC2 launch type. -See the [Requirements](/docs/ecs/get-started/requirements) and the full [Install Guide](/docs/ecs/get-started/install) when you're ready to install Consul on an existing ECS cluster and add existing tasks to the service mesh. +See the [Requirements](/docs/ecs/requirements) and the full [Install Guide](/docs/ecs/install) when you're ready to install Consul on an existing ECS cluster and add existing tasks to the service mesh. ## Architecture diff --git a/website/content/docs/ecs/get-started/install.mdx b/website/content/docs/ecs/install.mdx similarity index 98% rename from website/content/docs/ecs/get-started/install.mdx rename to website/content/docs/ecs/install.mdx index 9bca982489..bbd8a48d35 100644 --- a/website/content/docs/ecs/get-started/install.mdx +++ b/website/content/docs/ecs/install.mdx @@ -179,7 +179,7 @@ python manage.py runserver "127.0.0.1:8080" ## Next Steps -- Configure a secure [Production Installation](/docs/ecs/get-started/production-installation). +- Configure a secure [Production Installation](/docs/ecs/production-installation). - Now that your applications are running in the service mesh, read about other [Service Mesh features](/docs/connect). - View the [Architecture](/docs/ecs#architecture) documentation to understand diff --git a/website/content/docs/ecs/get-started/migrate-existing-tasks.mdx b/website/content/docs/ecs/migrate-existing-tasks.mdx similarity index 96% rename from website/content/docs/ecs/get-started/migrate-existing-tasks.mdx rename to website/content/docs/ecs/migrate-existing-tasks.mdx index aedca03911..0d6a069233 100644 --- a/website/content/docs/ecs/get-started/migrate-existing-tasks.mdx +++ b/website/content/docs/ecs/migrate-existing-tasks.mdx @@ -111,5 +111,5 @@ resource. Now that your task(s) are migrated to the `mesh-task` module, -- Start at the [ECS Service section](/docs/ecs/get-started/install#ecs-service) of the Installation Guide to continue installing Consul on ECS. +- Start at the [ECS Service section](/docs/ecs/install#ecs-service) of the Installation Guide to continue installing Consul on ECS. - Refer to the [`mesh-task` reference documentation](https://registry.terraform.io/modules/hashicorp/consul-ecs/aws/latest/submodules/mesh-task?tab=inputs) for all available inputs to your mesh tasks. diff --git a/website/content/docs/ecs/get-started/production-installation.mdx b/website/content/docs/ecs/production-installation.mdx similarity index 95% rename from website/content/docs/ecs/get-started/production-installation.mdx rename to website/content/docs/ecs/production-installation.mdx index 2f9bb0551e..19375ed9f6 100644 --- a/website/content/docs/ecs/get-started/production-installation.mdx +++ b/website/content/docs/ecs/production-installation.mdx @@ -68,7 +68,7 @@ deploying this controller. ## Deploy Services Once the ACL controller is up and running, you will be able to deploy services on the mesh using the [`mesh-task` module](https://registry.terraform.io/modules/hashicorp/consul-ecs/aws/latest/submodules/mesh-task). -Start with the basic configuration for the [Task Module](/docs/ecs/get-started/install#task-module) and specify additional settings to make the configuration production-ready. +Start with the basic configuration for the [Task Module](/docs/ecs/install#task-module) and specify additional settings to make the configuration production-ready. First, you will need to create an AWS Secrets Manager secret for the gossip encryption key that the Consul clients should use. @@ -104,5 +104,5 @@ module "my_task" { } ``` -Now you can deploy your services! Follow the rest of the steps in the [Installation instructions](/docs/ecs/get-started/install#task-module) +Now you can deploy your services! Follow the rest of the steps in the [Installation instructions](/docs/ecs/install#task-module) to deploy and connect your services. diff --git a/website/content/docs/ecs/get-started/requirements.mdx b/website/content/docs/ecs/requirements.mdx similarity index 100% rename from website/content/docs/ecs/get-started/requirements.mdx rename to website/content/docs/ecs/requirements.mdx diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index 58acc8c971..84a6a960b9 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -608,25 +608,20 @@ "path": "ecs" }, { - "title": "Get Started", - "routes": [ - { - "title": "Requirements", - "path": "ecs/get-started/requirements" - }, - { - "title": "Installation", - "path": "ecs/get-started/install" - }, - { - "title": "Production Installation", - "path": "ecs/get-started/production-installation" - }, - { - "title": "Migrate Existing Tasks", - "path": "ecs/get-started/migrate-existing-tasks" - } - ] + "title": "Requirements", + "path": "ecs/requirements" + }, + { + "title": "Installation", + "path": "ecs/install" + }, + { + "title": "Production Installation", + "path": "ecs/production-installation" + }, + { + "title": "Migrate Existing Tasks", + "path": "ecs/migrate-existing-tasks" }, { "title": "Consul Enterprise",