Skip to content

Commit ce7670e

Browse files
authored
docs: ref - relref consistency (#338)
1 parent 1a7e357 commit ce7670e

File tree

489 files changed

+2173
-2173
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

489 files changed

+2173
-2173
lines changed

.cloudcannon/schemas/nms/policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Confirm the policy is being enforced:
153153

154154
<!-- Add troubleshooting steps for issues users might encounter and can self-solve. The purpose of this section is to deflect customer calls to Support. -->
155155

156-
For help resolving common issues when setting up and configuring the policy, follow the steps in this section. If you cannot find a solution to your specific issue, reach out to [NGINX Customer Support]({{< relref "support/contact-support.md" >}}) for assistance.
156+
For help resolving common issues when setting up and configuring the policy, follow the steps in this section. If you cannot find a solution to your specific issue, reach out to [NGINX Customer Support]({{< ref "support/contact-support.md" >}}) for assistance.
157157

158158
### Issue 1
159159

CONTRIBUTING_DOCS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Here are two examples:
9191

9292
```md
9393
To install <software>, refer to the [installation instructions]({{< ref "install.md" >}}).
94-
To install <integation>, refer to the [integration instructions]({{< relref "/integration/thing.md#section" >}}).
94+
To install <integation>, refer to the [integration instructions]({{< ref "/integration/thing.md#section" >}}).
9595
```
9696

9797
### How to add images

content/agent/contribute/dev-environment-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ While most Linux or FreeBSD operating systems can be used to contribute to the N
1818

1919
## Install NGINX
2020

21-
Follow the steps in the [Installation]({{< relref "/agent/installation-upgrade/" >}}) section to download, install, and run NGINX and NGINX Agent.
21+
Follow the steps in the [Installation]({{< ref "/agent/installation-upgrade/" >}}) section to download, install, and run NGINX and NGINX Agent.
2222

2323
## Clone the NGINX Agent Repository
2424

content/agent/installation-upgrade/container-environments/docker-images.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ NGINX Agent is a companion daemon for NGINX Open Source or NGINX Plus instances
1414

1515
If you want to use NGINX Agent with NGINX Plus, you need to purchase an NGINX Plus license. Contact your F5 Sales representative for assistance.
1616

17-
See the requirements and supported operating systems in the [NGINX Agent Technical Specifications]({{< relref "/agent/technical-specifications.md" >}}) topic.
17+
See the requirements and supported operating systems in the [NGINX Agent Technical Specifications]({{< ref "/agent/technical-specifications.md" >}}) topic.
1818

1919
## Deploy Offical NGINX and NGINX Plus Containers
2020

@@ -113,7 +113,7 @@ docker tag docker-registry.nginx.com/nginx/agent:mainline nginx-agent
113113
docker run --name nginx-agent -d nginx-agent
114114
```
115115

116-
{{<note>}}To learn more about the configuration options, refer to the NGINX Agent [Configuration Overview]({{< relref "/agent/configuration/configuration-overview" >}}).{{</note>}}
116+
{{<note>}}To learn more about the configuration options, refer to the NGINX Agent [Configuration Overview]({{< ref "/agent/configuration/configuration-overview" >}}).{{</note>}}
117117

118118
### Enable the gRPC interface
119119

content/agent/installation-upgrade/container-environments/docker-support.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ type:
1010

1111
## Overview
1212

13-
The NGINX Agent repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that can be used to [build custom container images]({{< relref "/agent/installation-upgrade/container-environments/docker-images.md" >}}). Images are created with an NGINX Open Source or NGINX Plus instance and are available for various operating systems.
13+
The NGINX Agent repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that can be used to [build custom container images]({{< ref "/agent/installation-upgrade/container-environments/docker-images.md" >}}). Images are created with an NGINX Open Source or NGINX Plus instance and are available for various operating systems.
1414

15-
See the [Technical Specifications]({{< relref "/agent/technical-specifications.md#container-support" >}}) for a list of supported operationg systems.
15+
See the [Technical Specifications]({{< ref "/agent/technical-specifications.md#container-support" >}}) for a list of supported operationg systems.
1616

1717
NGINX Agent running in a container has some limitations that need to be considered, and are listed below.
1818

content/agent/installation-upgrade/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,5 +176,5 @@ NGINX Agent uses formatted log files to collect metrics. Expanding log formats a
176176
{{< important >}}
177177
Without log rotation or storage on a separate partition, log files could use up all the free drive space and cause your system to become unresponsive to certain services.
178178

179-
For more information, see [NGINX Agent Log Rotation]({{< relref "/agent/configuration/configuration-overview.md#nginx-agent-log-rotation" >}}).
179+
For more information, see [NGINX Agent Log Rotation]({{< ref "/agent/configuration/configuration-overview.md#nginx-agent-log-rotation" >}}).
180180
{{< /important >}}

content/agent/installation-upgrade/installation-oss.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Learn how to install NGINX Agent from the NGINX Open Source repository.
1515
## Prerequisites
1616

1717
- NGINX installed. Once installed, ensure it is running. If you don't have it installed already, follow these steps to install [NGINX](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-open-source/)
18-
- A [supported operating system and architecture]({{< relref "/agent/technical-specifications.md#supported-distributions" >}})
18+
- A [supported operating system and architecture]({{< ref "/agent/technical-specifications.md#supported-distributions" >}})
1919
- `root` privilege
2020

2121
## Configure NGINX OSS Repository for installing NGINX Agent

content/agent/installation-upgrade/installation-plus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Learn how to install NGINX Agent from NGINX Plus repository
1616

1717
- An NGINX Plus subscription (purchased or trial)
1818
- NGINX Plus installed. Once installed, ensure it is running. If you don't have it installed already, follow these steps to install [NGINX Plus](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus/)
19-
- A [supported operating system and architecture]({{< relref "/agent/technical-specifications.md#supported-distributions" >}})
19+
- A [supported operating system and architecture]({{< ref "/agent/technical-specifications.md#supported-distributions" >}})
2020
- `root` privilege
2121
- Your credentials to the MyF5 Customer Portal, provided by email from F5, Inc.
2222
- Your NGINX Plus certificate and public key (`nginx-repo.crt` and `nginx-repo.key` files), provided by email from F5, Inc.

content/amplify/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ This release includes the following updates:
3939

4040
### Known Issues
4141

42-
- You can find information about known issues with NGINX Amplify in the [Known Issues]({{< relref "/amplify/known-issues.md" >}}) topic.
42+
- You can find information about known issues with NGINX Amplify in the [Known Issues]({{< ref "/amplify/known-issues.md" >}}) topic.

content/amplify/faq/metrics-and-metadata.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ docs: DOCS-957
88

99
### What Data Does F5 NGINX Amplify Agent Gather?
1010

11-
[NGINX Amplify Agent Metrics and Metadata]({{< relref "/amplify/nginx-amplify-agent/metadata-metrics-collection" >}})
11+
[NGINX Amplify Agent Metrics and Metadata]({{< ref "/amplify/nginx-amplify-agent/metadata-metrics-collection" >}})
1212

13-
{{< note >}}For a complete list of metrics, refer to the [Metrics and Metadata documentation]({{< relref "/amplify/metrics-metadata" >}}).{{< /note >}}
13+
{{< note >}}For a complete list of metrics, refer to the [Metrics and Metadata documentation]({{< ref "/amplify/metrics-metadata" >}}).{{< /note >}}

0 commit comments

Comments
 (0)