Skip to content

Commit 43471a0

Browse files
ADubhlaoichpdabelf5
authored andcommitted
feat: Replace details HTML with Hugo shortcode (#1321)
This commit replaces the majority of instances of raw details HTML in the documentation repo with the Hugo shortcode instead. The remaining instances are exceptions to our rule of avoiding raw HTML in documentation, as they are bespoke interactive elements. The affected files have also had other formatting styles brought up to contemporary standards, such as metadata, the deprecation of the bootstrap shortcode, and the removal of horizontal lines.
1 parent 5fd32d4 commit 43471a0

File tree

27 files changed

+471
-741
lines changed

27 files changed

+471
-741
lines changed

.github/CODEOWNERS

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ content/nginx/nms/agent/* @nginx/nginx-agent
2626
content/nap-dos/* @nginx/dos-docs-approvers
2727

2828
# F5 WAF for NGINX
29-
content/nap-waf/* @nginx/nap-docs-approvers
30-
data/nap-waf/* @nginx/nap-docs-approvers
29+
content/waf/* @nginx/waf
30+
content/includes/waf/* @nginx/waf
3131

3232
# NGINXaaS for Azure
3333
content/nginxaas-azure/* @nginx/n4a-docs-approvers

content/agent/configuration/configuration-overview.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@ title: Basic configuration
33
draft: false
44
weight: 100
55
toc: true
6-
nd-docs: DOCS-1229
76
nd-content-type: how-to
7+
nd-product: Agent
8+
nd-docs: DOCS-1229
89
---
910

1011
The following sections explain how to configure NGINX Agent using configuration files, CLI flags, and environment variables.
@@ -27,8 +28,7 @@ The default locations of configuration files for NGINX Agent are `/etc/nginx-age
2728

2829
Examples of the configuration files are provided below:
2930

30-
<details open>
31-
<summary>example nginx-agent.conf</summary>
31+
{{< details summary="Open nginx-agent.conf example">}}
3232

3333
{{< 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.
@@ -112,11 +112,9 @@ nginx_app_protect:
112112
precompiled_publication: true
113113
```
114114

115-
</details>
116-
115+
{{< /details >}}
117116

118-
<details open>
119-
<summary>example dynamic-agent.conf</summary>
117+
{{< details summary="Open dynamic-agent.conf example">}}
120118

121119
{{< call-out "note" >}}
122120
Default location in Linux environments: `/var/lib/nginx-agent/agent-dynamic.conf`
@@ -146,7 +144,7 @@ tags:
146144
- qa
147145
```
148146
149-
</details>
147+
{{< /details >}}
150148
151149
## CLI Flags & Environment Variables
152150
@@ -239,8 +237,7 @@ Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.con
239237

240238
By default, NGINX Agent rotates logs daily using logrotate with the following configuration:
241239

242-
<details open>
243-
<summary>NGINX Agent Logrotate Configuration</summary>
240+
{{< details summary="Logrotate configuration example" >}}
244241

245242
``` yaml
246243
/var/log/nginx-agent/*.log
@@ -263,7 +260,7 @@ By default, NGINX Agent rotates logs daily using logrotate with the following co
263260
notifempty
264261
}
265262
```
266-
</details>
263+
{{< /details >}}
267264

268265
If you need to change the default configuration, update the file at `/etc/logrotate.d/nginx-agent`.
269266

content/includes/nim/disconnected/license-usage-offline-script.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
nd-docs: "DOCS-1662"
33
---
44

5-
<details closed>
6-
<summary style="font-weight:bold">View the full contents of the license_usage_offline.sh script</summary>
5+
{{< details summary="Full license_usage_offline.sh script" >}}
76

8-
``` bash
7+
```shell
98
#!/bin/bash
109

1110
# Function to encode the username and password to base64
@@ -413,4 +412,4 @@ curl --insecure --location "https://$ip_address/api/platform/v1/report/upload" \
413412
echo "Report acknowledgement successfully uploaded to NGINX Instance Manager $ip_address."
414413
```
415414

416-
</details>
415+
{{< /details >}}

content/ngf/install/helm.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@ To complete this guide, you will need:
2222

2323
{{< call-out "important" >}} If you’d like to use NGINX Plus, some additional setup is also required: {{< /call-out >}}
2424

25-
<details closed>
26-
<summary>NGINX Plus JWT setup</summary>
25+
{{< details summary="NGINX Plus JWT setup" >}}
2726

2827
{{< include "/ngf/installation/jwt-password-note.md" >}}
2928

@@ -41,7 +40,7 @@ To complete this guide, you will need:
4140

4241
{{< call-out "note" >}} For more information on why this is needed and additional configuration options, including how to report to NGINX Instance Manager instead, see the [NGINX Plus Image and JWT Requirement]({{< ref "/ngf/install/nginx-plus.md" >}}) document. {{< /call-out >}}
4342

44-
</details>
43+
{{< /details >}}
4544

4645
## Deploy NGINX Gateway Fabric
4746

content/ngf/install/manifests.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,7 @@ To complete this guide, you'll need to install:
2020

2121
{{< call-out "important" >}} If you’d like to use NGINX Plus, some additional setup is also required: {{< /call-out >}}
2222

23-
<details closed>
24-
<summary>NGINX Plus JWT setup</summary>
23+
{{< details summary="NGINX Plus JWT setup" >}}
2524

2625
{{< include "/ngf/installation/jwt-password-note.md" >}}
2726

@@ -39,7 +38,7 @@ To complete this guide, you'll need to install:
3938

4039
{{< call-out "note" >}} For more information on why this is needed and additional configuration options, including how to report to NGINX Instance Manager instead, see the [NGINX Plus Image and JWT Requirement]({{< ref "/ngf/install/nginx-plus.md" >}}) document. {{< /call-out >}}
4140

42-
</details>
41+
{{< /details >}}
4342

4443
## Deploy NGINX Gateway Fabric
4544

content/nginx-one/agent/install-upgrade/install-from-oss-repo.md

Lines changed: 23 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -29,59 +29,53 @@ Before you install NGINX Agent for the first time on your system, you need to se
2929
up the `nginx-agent` packages repository. Afterward, you can install and update
3030
NGINX Agent from the repository.
3131

32-
<details>
33-
<summary>Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux</summary>
34-
35-
### Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux
32+
### Install NGINX Agent on Alpine Linux
3633

37-
{{< include "/agent/installation/oss/oss-rhel.md" >}}
34+
{{< details summary="Expand instructions" >}}
3835

39-
</details>
36+
{{< include "/agent/installation/oss/oss-alpine.md" >}}
4037

41-
<details>
42-
<summary>Install NGINX Agent on Ubuntu</summary>
38+
{{< /details >}}
4339

44-
### Install NGINX Agent on Ubuntu
40+
### Install NGINX Agent on Amazon Linux
4541

46-
{{< include "/agent/installation/oss/oss-ubuntu.md" >}}
42+
{{< details summary="Expand instructions" >}}
4743

48-
</details>
44+
{{< include "/agent/installation/oss/oss-amazon-linux.md" >}}
4945

50-
<details>
51-
<summary>Install NGINX Agent on Debian</summary>
46+
{{< /details >}}
5247

5348
### Install NGINX Agent on Debian
5449

50+
{{< details summary="Expand instructions" >}}
51+
5552
{{< include "/agent/installation/oss/oss-debian.md" >}}
5653

57-
</details>
54+
{{< /details >}}
5855

59-
<details>
60-
<summary>Install NGINX Agent on SLES</summary>
56+
### Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux
6157

62-
### Install NGINX Agent on SLES
58+
{{< details summary="Expand instructions" >}}
6359

64-
{{< include "/agent/installation/oss/oss-sles.md" >}}
60+
{{< include "/agent/installation/oss/oss-rhel.md" >}}
6561

66-
</details>
62+
{{< /details >}}
6763

68-
<details>
69-
<summary>Install NGINX Agent on Alpine Linux</summary>
64+
### Install NGINX Agent on SLES
7065

71-
### Install NGINX Agent on Alpine Linux
66+
{{< details summary="Expand instructions" >}}
7267

73-
{{< include "/agent/installation/oss/oss-alpine.md" >}}
68+
{{< include "/agent/installation/oss/oss-sles.md" >}}
7469

75-
</details>
70+
{{< /details >}}
7671

77-
<details>
78-
<summary>Install NGINX Agent on Amazon Linux</summary>
72+
### Install NGINX Agent on Ubuntu
7973

80-
### Install NGINX Agent on Amazon Linux
74+
{{< details summary="Expand instructions" >}}
8175

82-
{{< include "/agent/installation/oss/oss-amazon-linux.md" >}}
76+
{{< include "/agent/installation/oss/oss-ubuntu.md" >}}
8377

84-
</details>
78+
{{< /details >}}
8579

8680
### Manually connect NGINX Agent to NGINX One Console
8781

content/nginx-one/agent/install-upgrade/install-from-plus-repo.md

Lines changed: 27 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
title: Install from NGINX Plus repo
33
toc: true
44
weight: 200
5-
docs: DOCS-000
5+
nd-content-type: how-to
6+
nd-product: NGINX One
67
nd-docs: DOCS-1877
78
---
89

@@ -16,7 +17,7 @@ For a quick guide on how to connect your instance to NGINX One Console see: [Con
1617

1718
## Overview
1819

19-
Follow the steps in this guide to install NGINX Agent in your NGINX instance using
20+
Follow the steps in this guide to install F5 NGINX Agent in your NGINX instance using
2021
the NGINX Plus repository.
2122

2223
## Before you begin
@@ -29,59 +30,53 @@ Before you install NGINX Agent for the first time on your system, you need to
2930
set up the `nginx-agent` packages repository. Afterward, you can install and update
3031
NGINX Agent from the repository.
3132

33+
### Install NGINX Agent on Alpine Linux
3234

33-
<details>
34-
<summary>Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux</summary>
35+
{{< details summary="Expand instructions" >}}
3536

36-
### Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux<a name="install-nginx-agent-on-rhel-centos-rocky-linux-almalinux-and-oracle-linux-plus"></a>
37-
38-
{{< include "/agent/installation/plus/plus-rhel.md" >}}
37+
{{< include "/agent/installation/plus/plus-alpine.md" >}}
3938

40-
</details>
39+
{{< /details >}}
4140

42-
<details>
43-
<summary>Install NGINX Agent on Ubuntu</summary>
41+
### Install NGINX Agent on Amazon Linux
4442

45-
### Install NGINX Agent on Ubuntu<a name="install-nginx-agent-on-ubuntu-plus"></a>
43+
{{< details summary="Expand instructions" >}}
4644

47-
{{< include "/agent/installation/plus/plus-ubuntu.md" >}}
45+
{{< include "/agent/installation/plus/plus-amazon-linux.md" >}}
4846

49-
</details>
47+
{{< /details >}}
5048

51-
<details>
52-
<summary>Install NGINX Agent on Debian</summary>
49+
### Install NGINX Agent on Debian
5350

54-
### Install NGINX Agent on Debian<a name="install-nginx-agent-on-debian-plus"></a>
51+
{{< details summary="Expand instructions" >}}
5552

5653
{{< include "/agent/installation/plus/plus-debian.md" >}}
5754

58-
</details>
55+
{{< /details >}}
5956

60-
<details>
61-
<summary>Install NGINX Agent on SLES</summary>
57+
### Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux
6258

63-
### Install NGINX Agent on SLES<a name="install-nginx-agent-on-sles-plus"></a>
59+
{{< details summary="Expand instructions" >}}
6460

65-
{{< include "/agent/installation/plus/plus-sles.md" >}}
61+
{{< include "/agent/installation/plus/plus-rhel.md" >}}
6662

67-
</details>
63+
{{< /details >}}
6864

69-
<details>
70-
<summary>Install NGINX Agent on Alpine Linux</summary>
65+
### Install NGINX Agent on SLES
7166

72-
### Install NGINX Agent on Alpine Linux<a name="install-nginx-agent-on-alpine-linux-plus"></a>
67+
{{< details summary="Expand instructions" >}}
7368

74-
{{< include "/agent/installation/plus/plus-alpine.md" >}}
69+
{{< include "/agent/installation/plus/plus-sles.md" >}}
7570

76-
</details>
77-
<details>
78-
<summary>Install NGINX Agent on Amazon Linux</summary>
71+
{{< /details >}}
7972

80-
### Install NGINX Agent on Amazon Linux<a name="install-nginx-agent-on-amazon-linux-plus"></a>
73+
### Install NGINX Agent on Ubuntu
8174

82-
{{< include "/agent/installation/plus/plus-amazon-linux.md" >}}
75+
{{< details summary="Expand instructions" >}}
76+
77+
{{< include "/agent/installation/plus/plus-ubuntu.md" >}}
8378

84-
</details>
79+
{{< /details >}}
8580

8681
### Manually connect NGINX Agent to NGINX One Console
8782

0 commit comments

Comments
 (0)