Merge pull request #527 from nginx/DOC-391

chore: rename hugo folder to site, fix product naming

hugo/content/configuration-overview.md → site/content/configuration-overview.md

@@ -12,11 +12,11 @@ doctypes: ["task"]
 
 ## Overview
 
-The following sections explain how to configure the NGINX Agent using configuration files, CLI flags, and environment variables.
+The following sections explain how to configure NGINX Agent using configuration files, CLI flags, and environment variables.
 
 {{<note>}}
 
-- The NGINX Agent interprets configuration values set by configuration files, CLI flags, and environment variables in the following priorities:
+- NGINX Agent interprets configuration values set by configuration files, CLI flags, and environment variables in the following priorities:
 
   1. CLI flags overwrite configuration files and environment variable values.
   2. Environment variables overwrite configuration file values.
@@ -28,7 +28,7 @@ The following sections explain how to configure the NGINX Agent using configurat
 
 ### Configure with Config Files
 
-The default locations of configuration files for the NGINX Agent are `/etc/nginx-agent/nginx-agent.conf` and `/var/lib/nginx-agent/agent-dynamic.conf`. The `agent-dynamic.conf` file default location is different for FreeBSD which is located `/var/db/nginx-agent/agent-dynamic.conf`. These files have comments at the top indicating their purpose.
+The default locations of configuration files for NGINX Agent are `/etc/nginx-agent/nginx-agent.conf` and `/var/lib/nginx-agent/agent-dynamic.conf`. The `agent-dynamic.conf` file default location is different for FreeBSD which is located `/var/db/nginx-agent/agent-dynamic.conf`. These files have comments at the top indicating their purpose.
 
 Examples of the configuration files are provided below:
 
@@ -99,7 +99,7 @@ extensions:
 
 # Enable reporting NGINX App Protect details to the control plane.
 nginx_app_protect:
-  # Report interval for NGINX App Protect details - the frequency the NGINX Agent checks NGINX App Protect for changes.
+  # Report interval for NGINX App Protect details - the frequency NGINX Agent checks NGINX App Protect for changes.
   report_interval: 15s
   # Enable precompiled publication from the NGINX Management Suite (true) or perform compilation on the data plane host (false).
   precompiled_publication: true
@@ -142,7 +142,7 @@ tags:
 
 ### NGINX Agent CLI Flags & Usage {#nginx-agent-cli-flags-usage}
 
-This section displays the configurable options for the NGINX Agent that can be set with CLI flags. See the CLI flags and their uses in the figure below:
+This section displays the configurable options for NGINX Agent that can be set with CLI flags. See the CLI flags and their uses in the figure below:
 
 <details open>
   <summary>NGINX Agent CLI flags & usage</summary>
@@ -201,8 +201,8 @@ Use "nginx-agent [command] --help" for more information about a command.
 
 #### NGINX Agent Config Dirs Option
 
-Use the `--config-dirs` command-line option, or the `config_dirs` key in the `nginx-agent.conf` file, to identify the directories the 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/management plane. The 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.
-The NGINX Agent follows NGINX configuration directives to file paths outside the designated directories and reads certificates' metadata. The NGINX Agent uses the following directives:
+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/management plane. 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.
+NGINX Agent follows NGINX configuration directives to file paths outside the designated directories and reads certificates' metadata. NGINX Agent uses the following directives:
 
 - [`ssl_certificate`](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_certificate)
 
@@ -216,7 +216,7 @@ Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.con
 
 ### NGINX Agent Environment Variables
 
-This section displays the configurable options for the NGINX Agent that can be set with environment variables. A list of the configurable environment variables can be seen below:
+This section displays the configurable options for NGINX Agent that can be set with environment variables. A list of the configurable environment variables can be seen below:
 
 <details open>
   <summary>NGINX Agent Environment Variables</summary>

hugo/content/dev-environment-setup.md → site/content/dev-environment-setup.md

@@ -47,7 +47,7 @@ sudo apt install -y protobuf-compiler
 
 Install NGINX Agent tools and dependencies:
 
-Before starting development on the NGINX Agent, it is important to download and install the necessary tool and dependencies required by the NGINX Agent. You can do this by running the following `make` command:
+Before starting development on NGINX Agent, it is important to download and install the necessary tool and dependencies required by NGINX Agent. You can do this by running the following `make` command:
 ```bash
 make install-tools deps
 ```

hugo/content/getting-started.md → site/content/getting-started.md

@@ -10,7 +10,7 @@ categories: ["configuration"]
 doctypes: ["task"]
 ---
 
-Follow these steps to configure and run NGINX Agent and a mock interface ("control plane") to which the NGINX Agent will report.
+Follow these steps to configure and run NGINX Agent and a mock interface ("control plane") to which NGINX Agent will report.
 
 ## Install NGINX
 
@@ -103,7 +103,7 @@ make launch-swagger-ui
 
 ## Extensions
 
-An extension is a piece of code, not critical to the main functionality that the NGINX agent is responsible for. This generally falls outside the remit of managing NGINX Configuration and reporting NGINX metrics.
+An extension is a piece of code, not critical to the main functionality that NGINX agent is responsible for. This generally falls outside the remit of managing NGINX Configuration and reporting NGINX metrics.
 
 To enable an extension, it must be added to the extensions list in the `/etc/nginx-agent/nginx-agent.conf`. 
 Here is an example of enabling the advanced metrics extension:
@@ -117,7 +117,7 @@ extensions:
 
 If already running, restart NGINX Agent to apply the new configuration. Alternatively, if NGINX Agent is not running, you may run it from the source code root directory.
 
-Open another terminal window and start the NGINX Agent. Issue the following command from the `agent` source code root directory.
+Open another terminal window and start NGINX Agent. Issue the following command from the `agent` source code root directory.
 
 ```shell
 sudo make run
@@ -157,13 +157,13 @@ For more NGINX Agent use cases, refer to the [NGINX Agent SDK examples](https://
 
 ## Start and Enable Start on Boot
 
-To start the NGINX Agent on `systemd` systems, run the following command:
+To start NGINX Agent on `systemd` systems, run the following command:
 
 ```shell
 sudo systemctl start nginx-agent
 ```
 
-To enable the NGINX Agent to start on boot, run the following command:
+To enable NGINX Agent to start on boot, run the following command:
 
 ```shell
 sudo systemctl enable nginx-agent

hugo/content/uninstall.md → site/content/uninstall.md

@@ -16,7 +16,7 @@ doctypes: ["task"]
 - The user following these steps will need `root` privilege
 
 ## Uninstalling NGINX Agent
-Complete the following steps on each host where you’ve installed the NGINX Agent
+Complete the following steps on each host where you’ve installed NGINX Agent
 
 
 - [Uninstalling NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux](#uninstalling-nginx-agent-on-rhel-centos-rocky-linux-almalinux-and-oracle-linux)
@@ -29,31 +29,31 @@ Complete the following steps on each host where you’ve installed the NGINX Age
 
 ### Uninstalling NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux
 
-Complete the following steps on each host where you've installed the NGINX Agent:
+Complete the following steps on each host where you've installed NGINX Agent:
 
-1. Stop the NGINX Agent:
+1. Stop NGINX Agent:
 
    ```bash
    sudo systemctl stop nginx-agent
    ```
 
-2. To uninstall the NGINX Agent, run the following command:
+2. To uninstall NGINX Agent, run the following command:
 
    ```bash
    sudo yum remove nginx-agent
    ```
 
 ### Uninstalling NGINX Agent on Ubuntu
 
-Complete the following steps on each host where you've installed the NGINX Agent:
+Complete the following steps on each host where you've installed NGINX Agent:
 
-1. Stop the NGINX Agent:
+1. Stop NGINX Agent:
 
    ```bash
    sudo systemctl stop nginx-agent
    ```
 
-2. To uninstall the NGINX Agent, run the following command:
+2. To uninstall NGINX Agent, run the following command:
 
    ```bash
    sudo apt-get remove nginx-agent
@@ -63,15 +63,15 @@ Complete the following steps on each host where you've installed the NGINX Agent
 
 ### Uninstalling NGINX Agent on Debian
 
-Complete the following steps on each host where you've installed the NGINX Agent:
+Complete the following steps on each host where you've installed NGINX Agent:
 
-1. Stop the NGINX Agent:
+1. Stop NGINX Agent:
 
    ```bash
    sudo systemctl stop nginx-agent
    ```
 
-2. To uninstall the NGINX Agent, run the following command:
+2. To uninstall NGINX Agent, run the following command:
 
    ```bash
    sudo apt-get remove nginx-agent
@@ -81,63 +81,63 @@ Complete the following steps on each host where you've installed the NGINX Agent
 
 ### Uninstalling NGINX Agent on SLES
 
-Complete the following steps on each host where you've installed the NGINX Agent:
+Complete the following steps on each host where you've installed NGINX Agent:
 
-1. Stop the NGINX Agent:
+1. Stop NGINX agent:
 
    ```bash
    sudo systemctl stop nginx-agent
    ```
 
-2. To uninstall the NGINX Agent, run the following command:
+2. To uninstall NGINX agent, run the following command:
 
    ```bash
    sudo zypper remove nginx-agent
    ``` 
 
 ### Uninstalling NGINX Agent on Alpine Linux
 
-Complete the following steps on each host where you've installed the NGINX Agent:
+Complete the following steps on each host where you've installed NGINX agent:
 
-1. Stop the NGINX Agent:
+1. Stop NGINX agent:
 
    ```bash
    sudo rc-service nginx-agent stop
    ```
 
-2. To uninstall the NGINX Agent, run the following command:
+2. To uninstall NGINX agent, run the following command:
 
    ```bash
    sudo apk del nginx-agent
    ``` 
 
 ### Uninstalling NGINX Agent on Amazon Linux
 
-Complete the following steps on each host where you've installed the NGINX Agent:
+Complete the following steps on each host where you've installed NGINX agent:
 
-1. Stop the NGINX Agent:
+1. Stop NGINX agent:
 
    ```bash
    sudo systemctl stop nginx-agent
    ```
 
-2. To uninstall the NGINX Agent, run the following command:
+2. To uninstall NGINX agent, run the following command:
 
    ```bash
    sudo yum remove nginx-agent
    ``` 
 
 ### Uninstalling NGINX Agent on FreeBSD
 
-Complete the following steps on each host where you've installed the NGINX Agent:
+Complete the following steps on each host where you've installed NGINX agent:
 
-1. Stop the NGINX Agent:
+1. Stop NGINX agent:
 
    ```bash
    sudo service nginx-agent stop
    ```
 
-2. To uninstall the NGINX Agent, run the following command:
+2. To uninstall NGINX agent, run the following command:
 
    ```bash
    sudo pkg delete nginx-agent

hugo/go.mod → site/go.mod

@@ -1,4 +1,4 @@
-module github.com/nginx/agent/hugo
+module github.com/nginx/agent/site
 
 go 1.18