From 521579724ebd7590fb75e09fda3c6966b2bf1a97 Mon Sep 17 00:00:00 2001 From: Jeff-Apple <79924108+Jeff-Apple@users.noreply.github.com> Date: Sun, 17 Apr 2022 20:41:29 -0700 Subject: [PATCH] Rename and re-title docs page for installing Consul API Gateway --- website/content/docs/api-gateway/common-errors.mdx | 2 +- ...-gateway-usage.mdx => consul-api-gateway-install.mdx} | 9 ++++----- website/data/docs-nav-data.json | 4 ++-- website/redirects.js | 5 +++++ 4 files changed, 12 insertions(+), 8 deletions(-) rename website/content/docs/api-gateway/{api-gateway-usage.mdx => consul-api-gateway-install.mdx} (98%) diff --git a/website/content/docs/api-gateway/common-errors.mdx b/website/content/docs/api-gateway/common-errors.mdx index d3ba51dca..f49c9fefc 100644 --- a/website/content/docs/api-gateway/common-errors.mdx +++ b/website/content/docs/api-gateway/common-errors.mdx @@ -64,4 +64,4 @@ Install the required CRDs by using the command in Step 1 of the [Consul API Gate ---> [consul-common-errors]: /docs/troubleshoot/common-errors [troubleshooting]: https://learn.hashicorp.com/consul/day-2-operations/advanced-operations/troubleshooting -[install-instructions]: /docs/api-gateway/api-gateway-usage#installation \ No newline at end of file +[install-instructions]: /docs/api-gateway/consul-api-gateway-install#installation \ No newline at end of file diff --git a/website/content/docs/api-gateway/api-gateway-usage.mdx b/website/content/docs/api-gateway/consul-api-gateway-install.mdx similarity index 98% rename from website/content/docs/api-gateway/api-gateway-usage.mdx rename to website/content/docs/api-gateway/consul-api-gateway-install.mdx index ac8474892..814959a1f 100644 --- a/website/content/docs/api-gateway/api-gateway-usage.mdx +++ b/website/content/docs/api-gateway/consul-api-gateway-install.mdx @@ -1,17 +1,17 @@ --- layout: docs -page_title: Consul API Gateway Usage +page_title: Consul API Gateway Install description: >- - Using Consul API gateway functionality + Installing Consul API Gateway --- -# Consul API Gateway Usage +# Installing Consul API Gateway This topic describes how to use the Consul API Gateway add-on module. It includes instructions for installation and configuration. ## Requirements -Refer to [Technical Specifications](/docs/api-gateway/tech-specs) for minimum software requirements. +Ensure that the environment you are deploying Consul API Gateway in meets the requirements listed in the [Technical Specifications](/docs/api-gateway/tech-specs). This includes validating that the requirements for minimum versions of software are met. ## Installation @@ -305,7 +305,6 @@ spec: - ### MeshService The `MeshService` configuration holds a reference to an externally-managed Consul service mesh service and can be used as a `backendRef` for a [`Route`](#route). diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index 1538aa9ac..0fa575b63 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -382,8 +382,8 @@ "path": "api-gateway" }, { - "title": "Usage", - "path": "api-gateway/api-gateway-usage" + "title": "Installation", + "path": "api-gateway/consul-api-gateway-install" }, { "title": "Technical Specifications", diff --git a/website/redirects.js b/website/redirects.js index ae6267704..4f0118b6a 100644 --- a/website/redirects.js +++ b/website/redirects.js @@ -1269,4 +1269,9 @@ module.exports = [ destination: '/docs/agent/config', permanent: true, }, + { + source: '/docs/api-gateway/api-gateway-usage', + destination: '/docs/api-gateway/consul-api-gateway-install', + permanent: true, + }, ]