feat: Customer-friendly NGINX One Console home page (#628)

* feat: Customer-friendly NGINX One Console home page

---------

Co-authored-by: Alan Dooley <[email protected]>

Author: mjang

content/includes/nginx-one/add-file/existing-ssl-bundle.md

@@ -2,7 +2,7 @@
 docs:
 ---
 
-With this option, You can incorporate [Managed certificates]({{< ref "/nginx-one/how-to/certificates/manage-certificates.md#managed-and-unmanaged-certificates" >}}).
+With this option, you can incorporate [Managed certificates]({{< ref "/nginx-one/nginx-configs/certificates/manage-certificates.md#managed-and-unmanaged-certificates" >}}).
 In the **Choose Certificate** drop-down, select the managed certificate of your choice, and select **Add**. You can then:
 
 1. Review details of the certificate. The next steps depend on whether the certificate is a CA bundle or a certificate / key pair.

content/includes/nginx-one/how-to/add-instance.md

@@ -0,0 +1,26 @@
+---
+docs:
+files:
+  - content/nginx-one/connect-instances/add-instance.md
+  - content/nginx-one/getting-started.md
+---
+
+You can add an instance to NGINX One Console in the following ways:
+
+- Directly, under **Instances**
+- Indirectly, by selecting a Config Sync Group, and selecting **Add Instance to Config Sync Group**
+
+In either case, NGINX One Console gives you a choice for data plane keys:
+
+- Create a new key
+- Use an existing key
+
+NGINX One Console takes the option you use, and adds the data plane key to a command that you'd use to register your target instance. You should see the command in the **Add Instance** screen in the console.
+
+Connect to the host where your NGINX instance is running. Run the provided command to [install NGINX Agent]({{< ref "/nginx-one/getting-started#install-nginx-agent" >}}) dependencies and packages on that host.
+
+```bash
+curl https://agent.connect.nginx.com/nginx-agent/install | DATA_PLANE_KEY="<data_plane_key>" sh -s -- -y
+```
+
+Once the process is complete, you can configure that instance in your NGINX One Console.

content/includes/use-cases/monitoring/n1c-dashboard-overview.md

@@ -0,0 +1,39 @@
+---
+docs:
+files:
+  - content/nginx-one/metrics/enable-metrics.md
+  - content/nginx-one/getting-started.md
+---
+
+Navigating the dashboard:
+
+- **Drill down into specifics**: For in-depth information on a specific metric, like expiring certificates, click on the relevant link in the metric's card to go to a detailed overview page.
+- **Refine metric timeframe**: Metrics show the last hour's data by default. To view data from a different period, select the time interval you want from the drop-down menu.
+
+<span style="display: inline-block; margin-top: 20px; margin-bottom: 50px;">
+{{< img src="nginx-one/images/nginx-one-dashboard.png">}}
+</span>
+
+{{<bootstrap-table "table table-striped table-bordered">}}
+**NGINX One dashboard metrics**
+| Metric | Description | Details |
+|---|---|---|
+| <i class="fas fa-heartbeat"></i> **Instance availability** | Understand the operational status of your NGINX instances. | - **Online**: The NGINX instance is actively connected and functioning properly. <br> - **Offline**: NGINX Agent is connected but the NGINX instance isn't running, isn't installed, or can't communicate with NGINX Agent. <br> - **Unavailable**: The connection between NGINX Agent and NGINX One has been lost or the instance has been decommissioned. <br> - **Unknown**: The current state can't be determined at the moment. |
+| <i class="fas fa-code-branch"></i> **NGINX versions by instance** | See which NGINX versions are in use across your instances. | |
+| <i class="fas fa-desktop"></i> **Operating systems** | Find out which operating systems your instances are running on. | |
+| <i class="fas fa-certificate"></i> **Certificates** | Monitor the status of your SSL certificates to know which are expiring soon and which are still valid. | |
+| <i class="fas fa-cogs"></i> **Config recommendations** | Get configuration recommendations to optimize your instances' settings. | |
+| <i class="fas fa-shield-alt"></i> **CVEs (Common Vulnerabilities and Exposures)** | Evaluate the severity and number of potential security threats in your instances. | - **Major**: Indicates a high-severity threat that needs immediate attention. <br> - **Medium**: Implies a moderate threat level. <br> - **Minor** and **Low**: Represent less critical issues that still require monitoring. <br> - **Other**: Encompasses any threats that don't fit the standard categories. |
+| <i class="fas fa-microchip"></i> **CPU utilization** | Track CPU usage trends and pinpoint instances with high CPU demand. | |
+| <i class="fas fa-memory"></i> **Memory utilization** | Watch memory usage patterns to identify instances using significant memory. | |
+| <i class="fas fa-hdd"></i> **Disk space utilization** | Monitor how much disk space your instances are using and identify those nearing capacity. | |
+| <i class="fas fa-exclamation-triangle"></i> **Unsuccessful response codes** | Look for instances with a high number of HTTP server errors and investigate their error codes. | |
+| <i class="fas fa-tachometer-alt"></i> **Top network usage** | Review the network usage and bandwidth consumption of your instances. | |
+
+{{</bootstrap-table>}}
+
+
+
+
+
+

content/nginx-one/about.md

@@ -1,7 +1,7 @@
 ---
 description: ''
 docs: DOCS-1392
-title: About
+title: Manage your NGINX fleet
 toc: true
 weight: 10
 type:

content/nginx-one/api/_index.md

@@ -1,6 +1,6 @@
 ---
-title: API
+title: Automate with the NGINX One API
 description:
-weight: 1000
+weight: 700
 url: /nginx-one/api
----
+---

content/nginx-one/changelog.md

@@ -83,8 +83,8 @@ You can:
 - Remove a deployed certificate from a Config Sync Group
 
 For more information, including warnings about risks, see our documentation on how you can:
-- [Add a file]({{< ref "/nginx-one/how-to/nginx-configs/add-file.md" >}})
-- [Manage certificates]({{< ref "/nginx-one/how-to/certificates/manage-certificates.md" >}})
+- [Add a file]({{< ref "/nginx-one/nginx-configs/add-file.md" >}})
+- [Manage certificates]({{< ref "/nginx-one/nginx-configs/certificates/manage-certificates.md" >}})
 
 ### Revert a configuration
 
@@ -108,15 +108,15 @@ From the NGINX One Console you can now:
 - Ensure that your certificates are current and correct.
 - Manage your certificates from a central location. This can help you simplify operations and remotely update, rotate, and deploy those certificates.
 
-For more information, see the full documentation on how you can [Manage Certificates]({{< ref "/nginx-one/how-to/certificates/manage-certificates.md" >}}).
+For more information, see the full documentation on how you can [Manage Certificates]({{< ref "/nginx-one/nginx-configs/certificates/manage-certificates.md" >}}).
 
 ## August 22, 2024
 
 ### Config Sync Groups
 
 Config Sync Groups are now available in the F5 NGINX One Console. This feature allows you to manage and synchronize NGINX configurations across multiple instances as a single entity, ensuring consistency and simplifying the management of your NGINX environment.
 
-For more information, see the full documentation on [Managing Config Sync Groups]({{< ref "/nginx-one/how-to/config-sync-groups/manage-config-sync-groups.md" >}}).
+For more information, see the full documentation on [Managing Config Sync Groups]({{< ref "/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md" >}}).
 
 ## August 8, 2024
 
@@ -136,7 +136,7 @@ Select the link for each CVE to see the details, including the CVE's publish dat
 
 ### Edit NGINX configurations
 
-You can now make configuration changes to your NGINX instances. For more details, see [View and edit NGINX configurations]({{< ref "/nginx-one/how-to/nginx-configs/view-edit-nginx-configurations.md" >}}).
+You can now make configuration changes to your NGINX instances. For more details, see [View and edit NGINX configurations]({{< ref "/nginx-one/nginx-configs/view-edit-nginx-configurations.md" >}}).
 
 ## May 28, 2024
 

content/nginx-one/connect-instances/_index.md

@@ -0,0 +1,6 @@
+---
+description:
+title: Connect your instances
+weight: 200
+url: /nginx-one/connect-instances/
+---

content/nginx-one/how-to/nginx-configs/add-instance.md renamed to content/nginx-one/connect-instances/add-instance.md

@@ -16,34 +16,16 @@ to set up a data plane key to connect your instances to NGINX One.
 
 Before you add an instance to NGINX One Console, ensure:
 
-- You have administrator access to NGINX One Console.
-- You have configured instances of NGINX that you want to manage through NGINX One Console.
-- You have or are ready to configure a data plane key.
-- You have or are ready to set up managed certificates.
+- You have [administrator access]({{< ref "/nginx-one/rbac/roles.md" >}}) to NGINX One Console.
+- You have [configured instances of NGINX]({{< ref "/nginx-one/getting-started.md#add-your-nginx-instances-to-nginx-one" >}}) that you want to manage through NGINX One Console.
+- You have or are ready to configure a [data plane key]({{< ref "/nginx-one/getting-started.md#generate-data-plane-key" >}}).
+- You have or are ready to set up [managed certificates]({{< ref "/nginx-one/nginx-configs/certificates/manage-certificates.md" >}}).
 
-{{< note >}}If this is the first time an instance is being added to a Config Sync Group, and you have not yet defined the configuration for that Config Sync Group, that instance provides the template for that group. For more information, see [Configuration management]({{< ref "nginx-one/how-to/config-sync-groups/manage-config-sync-groups#configuration-management" >}}).{{< /note >}}
+{{< note >}}If this is the first time an instance is being added to a Config Sync Group, and you have not yet defined the configuration for that Config Sync Group, that instance provides the template for that group. For more information, see [Configuration management]({{< ref "nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups#configuration-management" >}}).{{< /note >}}
 
 ## Add an instance
 
-You can add an instance to NGINX One Console in the following ways:
-
-- Directly, under **Instances**
-- Indirectly, by selecting a Config Sync Group, and selecting **Add Instance to Config Sync Group**
-
-In either case, NGINX One Console gives you a choice for data plane keys:
-
-- Create a new key
-- Use an existing key
-
-NGINX One Console takes the option you use, and adds the data plane key to a command that you'd use to register your target instance. You should see the command in the **Add Instance** screen in the console.
-
-Connect to the host where your NGINX instance is running. Run the provided command to [install NGINX Agent]({{< ref "/nginx-one/getting-started#install-nginx-agent" >}}) dependencies and packages on that host.
-
-```bash
-curl https://agent.connect.nginx.com/nginx-agent/install | DATA_PLANE_KEY="<data_plane_key>" sh -s -- -y
-```
-
-Once the process is complete, you can configure that instance in your NGINX One Console.
+{{< include "/nginx-one/how-to/add-instance.md" >}}
 
 ## Managed and Unmanaged Certificates
 
@@ -71,5 +53,5 @@ Once you've completed the process, NGINX One reassigns this as a managed certifi
 
 ## Add an instance to a Config Sync Group
 
-When you [Manage Config Sync Group membership]({{< ref "nginx-one/how-to/config-sync-groups/manage-config-sync-groups#manage-config-sync-group-membership" >}}), you can add an existing or new instance to the group of your choice.
+When you [Manage Config Sync Group membership]({{< ref "nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups#manage-config-sync-group-membership" >}}), you can add an existing or new instance to the group of your choice.
 That instance inherits the setup of that Config Sync Group.

content/nginx-one/how-to/containers/connect-nginx-plus-container-images-to-nginx-one.md renamed to content/nginx-one/connect-instances/connect-nginx-plus-container-images-to-nginx-one.md

@@ -1,7 +1,7 @@
 ---
 description: ''
 docs: null
-title: Connect NGINX Plus container images to NGINX One
+title: Connect NGINX Plus container images
 toc: true
 weight: 400
 type:
@@ -19,7 +19,7 @@ This guide explains how to set up an F5 NGINX Plus Docker container with NGINX A
 Before you start, make sure you have:
 
 - A valid JSON Web Token (JWT) for your NGINX subscription.
-- [A data plane key from NGINX One]({{< ref "/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md" >}}).
+- [A data plane key from NGINX One]({{< ref "/nginx-one/connect-instances/create-manage-data-plane-keys.md" >}}).
 - Docker installed and running on your system.
 
 #### Download your JWT license from MyF5

content/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md renamed to content/nginx-one/connect-instances/create-manage-data-plane-keys.md

@@ -1,7 +1,7 @@
 ---
 description: ''
 docs: DOCS-1395
-title: Create and manage data plane keys
+title: Prepare - Create and manage data plane keys
 toc: true
 weight: 100
 type:

content/nginx-one/how-to/proxy-setup/set-up-nginx-proxy-for-nginx-one.md renamed to content/nginx-one/connect-instances/set-up-nginx-proxy-for-nginx-one.md

@@ -1,7 +1,7 @@
 ---
 description: ''
 docs: null
-title: Set up NGINX as a proxy for NGINX One
+title: Minimize connections - Set up NGINX as a proxy
 toc: true
 weight: 300
 type:
@@ -17,7 +17,7 @@ This guide explains how to set up NGINX as a proxy for other NGINX instances to
 ## Before you start
 
 - [Install NGINX Open Source or NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/" >}}).
-- [Get a Data Plane Key from NGINX One]({{< ref "/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md" >}}).
+- [Get a Data Plane Key from NGINX One]({{< ref "/nginx-one/connect-instances/create-manage-data-plane-keys.md" >}}).
 
 ---
 
@@ -61,7 +61,7 @@ In this step, we'll configure an NGINX instance to act as a proxy server for NGI
 
 ---
 
-## Configure NGINX Agent to use the proxy instance
+## Configure NGINX Agent to use the proxy
 
 To set up your other NGINX instances to use the proxy instance to connect to NGINX One, update the NGINX Agent configuration on those instances to use the proxy NGINX instance's IP address. See the example NGINX Agent configuration below.
 
@@ -95,7 +95,7 @@ To set up your other NGINX instances to use the proxy instance to connect to NGI
 
 For more information, refer to the following resources:
 
-- [Installing NGINX and NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/" >}})
-- [Create and manage data plane keys]({{< ref "/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md" >}})
+- [Install NGINX and NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/" >}})
+- [Create and manage data plane keys]({{< ref "/nginx-one/connect-instances/create-manage-data-plane-keys.md" >}})
 - [NGINX Agent Installation and upgrade](https://docs.nginx.com/nginx-agent/installation-upgrade/)
-- [NGINX Agent Configuration](https://docs.nginx.com/nginx-agent/configuration/)
+- [NGINX Agent Configuration](https://docs.nginx.com/nginx-agent/configuration/)

content/nginx-one/how-to/settings/_index.md renamed to content/nginx-one/connect-instances/settings/_index.md

@@ -2,6 +2,6 @@
 description:
 title: Settings
 weight: 500
-url: /nginx-one/how-to/settings  
+url: /nginx-one/connect-instances/settings  
 draft: true
 ---

content/nginx-one/getting-started.md

@@ -24,12 +24,10 @@ To get started using NGINX One, enable the service on F5 Distributed Cloud.
 
 Next, add your NGINX instances to NGINX One. You'll need to create a data plane key and then install NGINX Agent on each instance you want to monitor.
 
-### Add an instance
-
-Depending on whether this is your first time using NGINX One Console or you've used it before, follow the appropriate steps to add an instance:
+The following instructions include minimal information, sufficient to "get started." See the following links for detailed instructions:
 
-- **For first-time users:** On the welcome screen, select **Add Instance**.
-- **For returning users:** If you've added instances previously and want to add more, select **Instances** on the left menu, then select **Add Instance**.
+- [Create and manage data plane keys]({{< ref "/nginx-one/connect-instances/create-manage-data-plane-keys.md" >}})
+- [Add an NGINX instance]({{< ref "/nginx-one/connect-instances/add-instance.md" >}})
 
 ### Generate a data plane key {#generate-data-plane-key}
 
@@ -43,11 +41,18 @@ To generate a data plane key:
 {{<call-out "caution" "Data plane key guidelines" "fas fa-key" >}}
 Data plane keys are displayed only once and cannot be retrieved later. Be sure to copy and store this key securely.
 
-Data plane keys expire after one year. You can change this expiration date later by [editing the key]({{< ref "nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md#change-expiration-date" >}}).
+Data plane keys expire after one year. You can change this expiration date later by [editing the key]({{< ref "nginx-one/connect-instances/create-manage-data-plane-keys.md#change-expiration-date" >}}).
 
-[Revoking a data plane key]({{< ref "nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md#revoke-data-plane-key" >}}) disconnects all instances that were registered with that key.
+[Revoking a data plane key]({{< ref "nginx-one/connect-instances/create-manage-data-plane-keys.md#revoke-data-plane-key" >}}) disconnects all instances that were registered with that key.
 {{</call-out>}}
 
+### Add an instance
+
+Depending on whether this is your first time using NGINX One Console or you've used it before, follow the appropriate steps to add an instance:
+
+- **For first-time users:** On the welcome screen, select **Add Instance**.
+- **For returning users:** If you've added instances previously and want to add more, select **Instances** on the left menu, then select **Add Instance**.
+
 
 ### Install NGINX Agent
 
@@ -134,37 +139,11 @@ If you followed the [Installation and upgrade](https://docs.nginx.com/nginx-agen
 
 ---
 
-## Enable NGINX metrics reporting
-
 The NGINX One Console dashboard relies on APIs for NGINX Plus and NGINX Open Source Stub Status to report traffic and system metrics. The following sections show you how to enable those metrics.
 
 ### Enable NGINX Plus API
 
-<!-- possible future include: "/use-cases/monitoring/enable-nginx-plus-api.md" -->
-To collect metrics for NGINX Plus, add the following to your NGINX Plus configuration file:
-
-```nginx
-# Enable the /api/ location with appropriate access control
-# to use the NGINX Plus API.
-#
-location /api/ {
-    api write=on;
-    allow 127.0.0.1;
-    deny all;
-}
-```
-
-This configuration:
-
-- Enables the NGINX Plus API.
-- Allows requests only from `127.0.0.1` (localhost).
-- Blocks all other requests for security.
-
-After saving the changes, reload NGINX to apply the new configuration:
-
-```shell
-nginx -s reload
-```
+{{< include "/use-cases/monitoring/enable-nginx-plus-api.md" >}}
 
 ### Enable NGINX Open Source Stub Status API
 
@@ -183,6 +162,8 @@ After connecting your NGINX instances to NGINX One, you can monitor their perfor
 
 ### Overview of the NGINX One dashboard
 
+{{< include "/use-cases/monitoring/n1c-dashboard-overview.md" >}}
+
 Navigating the dashboard:
 
 - **Drill down into specifics**: For in-depth information on a specific metric, like expiring certificates, click on the relevant link in the metric's card to go to a detailed overview page.