Skip to content

Commit 24e6488

Browse files
authored
feat: Update old call-outs to use new style (#925)
This commit replaces all instances of the old call-out style with the new one. The new style is more generic, with contributors using a parameter to denote the type of call-out. Instances of the new call-out style are also more consistent to our general Hugo formatting style: previously, empty space usage was highly inconsistent. These changes should address the terminal warnings, and are more futureproof for updates to the theme in the future.
1 parent fb92a70 commit 24e6488

File tree

540 files changed

+2294
-2294
lines changed

Some content is hidden

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

540 files changed

+2294
-2294
lines changed

.cloudcannon/schemas/default.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ To do xzy, take the following steps:
3939

4040
2. Format as numbered lists.
4141

42-
{{< note >}}Add notes like this.{{</note>}}
42+
{{< call-out "note" >}}Add notes like this.{{< /call-out >}}
4343

4444
3. If there is only one step, you don't need to format it as a numbered list.
4545

.cloudcannon/schemas/nms/policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ The following table lists the configurable settings and their default values for
8181

8282
{{%tab name="API"%}}
8383

84-
{{<see-also>}}{{< include "acm/how-to/access-acm-api.md" >}}{{</see-also>}}
84+
{{< call-out "note" >}}{{< include "acm/how-to/access-acm-api.md" >}}{{< /call-out >}}
8585

8686
To create an XYZ policy using the REST API, send an HTTP `POST` request to the Add-Endpoint-Name-Here endpoint.
8787

content/agent/configuration/configuration-overview.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ nd-content-type: how-to
99

1010
The following sections explain how to configure NGINX Agent using configuration files, CLI flags, and environment variables.
1111

12-
{{<note>}}
12+
{{< call-out "note" >}}
1313

1414
- NGINX Agent interprets configuration values set by configuration files, CLI flags, and environment variables in the following priorities:
1515

@@ -19,7 +19,7 @@ The following sections explain how to configure NGINX Agent using configuration
1919

2020
- You must open any required firewall ports or add SELinux/AppArmor rules for the ports and IPs you want to use.
2121

22-
{{</note>}}
22+
{{< /call-out >}}
2323

2424
## Configure with Config Files
2525

@@ -30,9 +30,9 @@ Examples of the configuration files are provided below:
3030
<details open>
3131
<summary>example nginx-agent.conf</summary>
3232

33-
{{<note>}}
33+
{{< call-out "note" >}}
3434
In the following example `nginx-agent.conf` file, you can change the `server.host` and `server.grpcPort` to connect to the control plane.
35-
{{</note>}}
35+
{{< /call-out >}}
3636

3737
```nginx {hl_lines=[13]}
3838
#
@@ -118,11 +118,11 @@ nginx_app_protect:
118118
<details open>
119119
<summary>example dynamic-agent.conf</summary>
120120

121-
{{<note>}}
121+
{{< call-out "note" >}}
122122
Default location in Linux environments: `/var/lib/nginx-agent/agent-dynamic.conf`
123123

124124
Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.conf`
125-
{{</note>}}
125+
{{< /call-out >}}
126126

127127
```yaml
128128
# Dynamic configuration file for NGINX Agent.
@@ -169,13 +169,13 @@ nginx-agent
169169

170170
### CLI Flags and Environment Variables
171171

172-
{{< warning >}}
172+
{{< call-out "warning" >}}
173173

174174
Before version 2.35.0, the environment variables were prefixed with `NMS_` instead of `NGINX_AGENT_`.
175175

176176
If you are upgrading from an older version, update your configuration accordingly.
177177

178-
{{< /warning >}}
178+
{{< /call-out >}}
179179

180180
{{<bootstrap-table "table table-responsive table-bordered">}}
181181
| CLI flag | Environment variable | Description |
@@ -218,7 +218,7 @@ If you are upgrading from an older version, update your configuration accordingl
218218

219219
<br>
220220

221-
{{<note>}}
221+
{{< call-out "note" >}}
222222
Use the `--config-dirs` command-line option, or the `config_dirs` key in the `nginx-agent.conf` file, to identify the directories NGINX Agent can read from or write to. This setting also defines the location to which you can upload config files when using a control plane.
223223

224224
NGINX Agent cannot write to directories outside the specified location when updating a config and cannot upload files to directories outside of the configured location.
@@ -227,15 +227,15 @@ NGINX Agent follows NGINX configuration directives to file paths outside the des
227227

228228
- [`ssl_certificate`](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_certificate)
229229

230-
{{</note>}}
230+
{{< /call-out >}}
231231

232-
{{<note>}} Use the `--dynamic-config-path` command-line option to set the location of the dynamic config file. This setting also requires you to move your dynamic config to the new path, or create a new dynamic config file at the specified location.
232+
{{< call-out "note" >}} Use the `--dynamic-config-path` command-line option to set the location of the dynamic config file. This setting also requires you to move your dynamic config to the new path, or create a new dynamic config file at the specified location.
233233

234234
Default location in Linux environments: `/var/lib/nginx-agent/agent-dynamic.conf`
235235

236236
Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.conf`
237237

238-
{{</note>}}
238+
{{< /call-out >}}
239239

240240
## Log Rotation
241241

content/agent/configuration/encrypt-communication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ NGINX_AGENT_TLS_ENABLE=true
9494

9595
## Enable Server-Side TLS With Self-Signed Certificate
9696

97-
{{< warning >}}These steps are not recommended for production environments.{{< /warning >}}
97+
{{< call-out "warning" >}}These steps are not recommended for production environments.{{< /call-out >}}
9898

9999
To enable server-side TLS with a self-signed certificate, you must have TLS enabled and set `skip_verify` to `true`, which disables hostname validation. Setting `skip_verify` can be done done only by updating the configuration file. See the following example:
100100

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This guide provides instructions on how to build images with NGINX Agent and NGI
2727

2828
You can use [Docker](https://docs.docker.com/engine/install/) or [Podman](https://podman.io/docs/installation) to manage NGINX Agent container images. Follow the installation instructions for your preferred container engine and be sure the service is running before proceeding with the instructions in this document.
2929

30-
{{<note>}}The examples in this document primarily use Docker commands. You can adapt these using the appropriate [Podman commands](https://docs.podman.io/en/latest/Commands.html) if you're not using Docker.{{</note>}}
30+
{{< call-out "note" >}}The examples in this document primarily use Docker commands. You can adapt these using the appropriate [Podman commands](https://docs.podman.io/en/latest/Commands.html) if you're not using Docker.{{< /call-out >}}
3131

3232
### Install the GNU Make package
3333

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

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

117117
### Enable the gRPC interface
118118

@@ -166,7 +166,7 @@ If the REST Interface is configured correctly, then you should see a JSON object
166166
167167
## Build the NGINX Agent images for specific OS targets
168168
169-
{{<important>}}The only **officially supported** base operating system is **Alpine**. The instructions below for other operating systems are provided for informational and **testing purposes only**.{{</important>}}
169+
{{< call-out "important" >}}The only **officially supported** base operating system is **Alpine**. The instructions below for other operating systems are provided for informational and **testing purposes only**.{{< /call-out >}}
170170
171171
The NGINX Agent GitHub repo has a set of Make commands that you can use to build a container image for an specific operating system and version:
172172
@@ -200,7 +200,7 @@ IMAGE_BUILD_TARGET=install-agent-repo NGINX_AGENT_VERSION=2.37.0~bullseye OS_REL
200200
201201
### Build NGINX Plus images
202202
203-
{{<important>}}You need a license to use NGINX Agent with NGINX Plus. You must complete the steps in the [Download the certificate and key files from MyF5](#myf5-download) section before proceeding.{{</important>}}
203+
{{< call-out "important" >}}You need a license to use NGINX Agent with NGINX Plus. You must complete the steps in the [Download the certificate and key files from MyF5](#myf5-download) section before proceeding.{{< /call-out >}}
204204
205205
Run the following `make` command to build the default image, which uses Ubuntu 24.04 (Noble) as the base image.
206206

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,8 +172,8 @@ sudo systemctl enable nginx-agent
172172

173173
NGINX Agent uses formatted log files to collect metrics. Expanding log formats and instance counts will also increase the size of the NGINX Agent log files. We recommend adding a separate partition for `/var/log/nginx-agent`.
174174

175-
{{< important >}}
175+
{{< call-out "important" >}}
176176
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.
177177

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

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Before you install NGINX Agent for the first time on your system, you need to se
9595
uid nginx signing key <[email protected]>
9696
```
9797

98-
{{< important >}}If the fingerprint is different, remove the file.{{< /important >}}
98+
{{< call-out "important" >}}If the fingerprint is different, remove the file.{{< /call-out >}}
9999

100100
1. Add the nginx agent repository:
101101

@@ -159,7 +159,7 @@ Before you install NGINX Agent for the first time on your system, you need to se
159159
uid nginx signing key <[email protected]>
160160
```
161161

162-
{{< important >}}If the fingerprint is different, remove the file.{{< /important >}}
162+
{{< call-out "important" >}}If the fingerprint is different, remove the file.{{< /call-out >}}
163163

164164
1. Add the `nginx-agent` repository:
165165

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ The installation process involves installing NGINX Plus without root privileges
3030

3131
You can install NGINX Plus without root privileges following the steps on the [NGINX Plus installation page]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus/#unpriv_install" >}}). The steps include a script that will allow you to install NGINX Plus in a non-root environment.
3232

33-
{{< note >}}
33+
{{< call-out "note" >}}
3434
NGINX Agent has its own user group (`nginx-agent`) which is created when NGINX Agent is installed. The user NGINX is running under is added to this user group during the installation of NGINX Agent. If you change the NGINX user after installing NGINX Agent, you will need to [manually add the new NGINX user]({{< ref "/agent/configuration/configure-nginx-agent-group.md" >}}) to the `nginx-agent` group.
35-
{{< /note >}}
35+
{{< /call-out >}}
3636

3737
### Install NGINX Agent
3838

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ nd-docs: DOCS-957
1010

1111
[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]({{< ref "/amplify/metrics-metadata" >}}).{{< /note >}}
13+
{{< call-out "note" >}}For a complete list of metrics, refer to the [Metrics and Metadata documentation]({{< ref "/amplify/metrics-metadata" >}}).{{< /call-out >}}

content/amplify/faq/user-interface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ To completely delete a previously monitored object follow these steps:
2929

3030
To delete a system using the web interface — find it in the [Inventory]({{< ref "/amplify/user-interface/inventory" >}}), and select the [i] icon. You can delete objects from the popup window that appears next.
3131

32-
{{< important >}}Deleting objects in the User Interface will not stop NGINX Amplify Agent. To completely remove a system from monitoring, please stop or uninstall NGINX Amplify Agent, clean it up in the web interface, and clean up any alerts.{{< /important >}}
32+
{{< call-out "important" >}}Deleting objects in the User Interface will not stop NGINX Amplify Agent. To completely remove a system from monitoring, please stop or uninstall NGINX Amplify Agent, clean it up in the web interface, and clean up any alerts.{{< /call-out >}}

0 commit comments

Comments
 (0)