Merge pull request #12811 from hashicorp/japple-rename-apigw-install-doc

Docs: Rename and re-title docs page for installing Consul API Gateway
This commit is contained in:
Jeff Apple 2022-04-18 07:21:03 -07:00 committed by GitHub
commit c90315a8e1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 12 additions and 8 deletions

View File

@ -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 [consul-common-errors]: /docs/troubleshoot/common-errors
[troubleshooting]: https://learn.hashicorp.com/consul/day-2-operations/advanced-operations/troubleshooting [troubleshooting]: https://learn.hashicorp.com/consul/day-2-operations/advanced-operations/troubleshooting
[install-instructions]: /docs/api-gateway/api-gateway-usage#installation [install-instructions]: /docs/api-gateway/consul-api-gateway-install#installation

View File

@ -1,17 +1,17 @@
--- ---
layout: docs layout: docs
page_title: Consul API Gateway Usage page_title: Consul API Gateway Install
description: >- 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. This topic describes how to use the Consul API Gateway add-on module. It includes instructions for installation and configuration.
## Requirements ## 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 ## Installation
@ -305,7 +305,6 @@ spec:
</CodeBlockConfig> </CodeBlockConfig>
### MeshService ### 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). 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).

View File

@ -382,8 +382,8 @@
"path": "api-gateway" "path": "api-gateway"
}, },
{ {
"title": "Usage", "title": "Installation",
"path": "api-gateway/api-gateway-usage" "path": "api-gateway/consul-api-gateway-install"
}, },
{ {
"title": "Technical Specifications", "title": "Technical Specifications",

View File

@ -1269,4 +1269,9 @@ module.exports = [
destination: '/docs/agent/config', destination: '/docs/agent/config',
permanent: true, permanent: true,
}, },
{
source: '/docs/api-gateway/api-gateway-usage',
destination: '/docs/api-gateway/consul-api-gateway-install',
permanent: true,
},
] ]