DP-64: Add meta descriptions to each page in the operation guide

Added meta data descriptions for the remaining sections of the operation section of the Horizon/Meridian documentation for better SEO.
OpenNMS · Aug 31, 2023 · 4de9f07 · 4de9f07
1 parent bb3175f
commit 4de9f07
Show file tree

Hide file tree

Showing 26 changed files with 26 additions and 0 deletions.
diff --git a/docs/modules/operation/pages/deep-dive/admin/configuration/config-tester.adoc b/docs/modules/operation/pages/deep-dive/admin/configuration/config-tester.adoc
@@ -1,5 +1,6 @@
 
 = Configuration Tester
+:description: Learn how the configuration tester can help you identify configuration problems in OpenNMS Horizon/Meridian.
 
 To identify configuration problems, use the configuration tester located in `$\{OPENNMS_HOME}/bin/`.
 You can use the tool when {page-component-title} is either running or stopped.

diff --git a/.../modules/operation/pages/deep-dive/admin/configuration/daemon-config-files.adoc b/.../modules/operation/pages/deep-dive/admin/configuration/daemon-config-files.adoc
@@ -1,5 +1,6 @@
 
 = Daemon Configuration Files
+:description: Learn how to change daemon configuration files in OpenNMS Horizon/Meridian and which daemons require you to restart to load configuration updates.
 
 This section explains how to implement changes to daemon configuration files, and which daemons require you to restart {page-component-title} to load configuration updates.
 

diff --git a/docs/modules/operation/pages/deep-dive/admin/configuration/data-collection.adoc b/docs/modules/operation/pages/deep-dive/admin/configuration/data-collection.adoc
@@ -1,5 +1,6 @@
 
 = Data Collection
+:description: Learn what anonymous use statistics OpenNMS Horizon/Meridian collects and publishes.
 
 When enabled, the Data Choices module collects anonymous use statistics.
 It publishes them on system startup and every 24 hours after.

diff --git a/docs/modules/operation/pages/deep-dive/admin/configuration/external-auth.adoc b/docs/modules/operation/pages/deep-dive/admin/configuration/external-auth.adoc
@@ -1,5 +1,6 @@
 
 = External Authentication
+:description: Learn how to configure external authentication like Active Directory, Novell eDirectory, or another LDAP-enabled directory in OpenNMS Horizon/Meridian.
 
 If you have an existing directory for authenticating users, you can configure {page-component-title} to use that system to grant users access to log in, in addition to allowing log in from users defined directly within your {page-component-title} server.
 

diff --git a/docs/modules/operation/pages/deep-dive/admin/configuration/geocoder.adoc b/docs/modules/operation/pages/deep-dive/admin/configuration/geocoder.adoc
@@ -1,5 +1,6 @@
 
 = Geocoder Service
+:description: Learn how to enable the geocoder service in OpenNMS Horizon/Meridian to resolve geolocation information with Google, MapQuest, and Nominatim.
 
 The geocoder service resolves geolocation information in {page-component-title}.
 {page-component-title} also supports several external geocoder services.

diff --git a/docs/modules/operation/pages/deep-dive/admin/configuration/https/https-client.adoc b/docs/modules/operation/pages/deep-dive/admin/configuration/https/https-client.adoc
@@ -1,6 +1,7 @@
 
 [[ga-operation-https-client]]
 = SSL Client Connections
+:description: Learn how to create a custom Java truststore in OpenNMS Horizon/Meridian to establish SSL connections with monitored nodes.
 
 The Java truststore enables {page-component-title} to establish SSL connections with monitored nodes.
 

diff --git a/docs/modules/operation/pages/deep-dive/admin/configuration/https/https-server.adoc b/docs/modules/operation/pages/deep-dive/admin/configuration/https/https-server.adoc
@@ -1,5 +1,6 @@
 
 = Secure Jetty with HTTPS
+:description: Learn how to configure the built-in Jetty web server in OpenNMS Horizon/Meridian to support HTTPS.
 
 If you access the {page-component-title} web UI via untrusted networks, it is best practice to use HTTPS to protect incoming web sessions.
 This section explains how to configure {page-component-title}'s built-in Jetty web server to support HTTPS.

diff --git a/...odules/operation/pages/deep-dive/admin/configuration/https/request-logging.adoc b/...odules/operation/pages/deep-dive/admin/configuration/https/request-logging.adoc
@@ -1,5 +1,6 @@
 
 = Enable Request Logs
+:description: Learn how to enable HTTP request logs for Jetty in OpenNMS Horizon/Meridian.
 
 You can enable HTTP request logs for Jetty by removing the comment tags from the following snippet in `etc/jetty.xml`:
 

diff --git a/docs/modules/operation/pages/deep-dive/admin/configuration/introduction.adoc b/docs/modules/operation/pages/deep-dive/admin/configuration/introduction.adoc
@@ -1,4 +1,5 @@
 
 = {page-component-title} Configuration
+:description: Overview of configuration section in the OpenNMS Horizon/Meridian documentation.
 
 This section explains the configuration options available for various {page-component-title} components.
diff --git a/docs/modules/operation/pages/deep-dive/admin/configuration/rmi.adoc b/docs/modules/operation/pages/deep-dive/admin/configuration/rmi.adoc
@@ -1,5 +1,6 @@
 
 = Enable RMI
+:description: Learn how to enable the RMI port in OpenNMS Horizon/Meridian to let you access Horizon/Meridian via jconsole and remotely manage your instance.
 
 By default, the {page-component-title} server's RMI port is disabled for security reasons.
 When enabled, it lets you access {page-component-title} via `jconsole` and remotely manage your instance.

diff --git a/docs/modules/operation/pages/deep-dive/admin/configuration/same-site-cookie.adoc b/docs/modules/operation/pages/deep-dive/admin/configuration/same-site-cookie.adoc
@@ -1,5 +1,6 @@
 
 = SameSite Cookie Attribute
+:description: Learn how to configure the SameSite Cookie attribute in OpenNMS Horizon/Meridian to relax the cookie enforcement policy.
 
 The SameSite Cookie attribute controls access to cookies and helps prevent various cross-site scripting (XSS) and cross-site request forgery (CSRF) attacks.
 This attribute tells browsers how to handle first- or third-party cookies and identifies whether to allow a cookie to be accessed.

diff --git a/docs/modules/operation/pages/deep-dive/admin/configuration/scv-configuration.adoc b/docs/modules/operation/pages/deep-dive/admin/configuration/scv-configuration.adoc
@@ -1,5 +1,6 @@
 
 = Secure Credentials Vault
+:description: Learn how to configure the secure credentials vault to encrypt the credentials that OpenNMS Horizon/Meridian uses.
 
 The secure credentials vault lets you encrypt credentials that {page-component-title} uses.
 It stores them in the Java keystore (JKS) format.

diff --git a/docs/modules/operation/pages/deep-dive/admin/configuration/startup.adoc b/docs/modules/operation/pages/deep-dive/admin/configuration/startup.adoc
@@ -1,5 +1,6 @@
 
 = Startup Configuration
+:description: Learn about startup settings you can configure in OpenNMS Horizon/Meridian.
 
 There are a number of startup settings that you can configure, including `JAVA_HEAP_SIZE`.
 {page-component-title} startup scripts load `$\{OPENNMS_HOME}/etc/opennms.conf` early in their startup, if that file exists.

diff --git a/docs/modules/operation/pages/deep-dive/admin/configuration/system-properties.adoc b/docs/modules/operation/pages/deep-dive/admin/configuration/system-properties.adoc
@@ -1,6 +1,7 @@
 
 [[system-properties]]
 = Configure System Properties
+:description: Learn how properties files let you configure OpenNMS Horizon/Meridian global behavior settings.
 
 Properties files let you configure {page-component-title}'s global behavior settings.
 They are stored in `$\{OPENNMS_HOME}/etc`.

diff --git a/docs/modules/operation/pages/deep-dive/admin/configuration/system-proxies.adoc b/docs/modules/operation/pages/deep-dive/admin/configuration/system-proxies.adoc
@@ -1,5 +1,6 @@
 
 = Configure System Proxies
+:description: Learn how to enable system servers in OpenNMS Horizon/Meridian.
 
 You can enable system proxy settings with certain {page-component-title} components by setting the `use-system-proxy` or `useSystemProxy` parameters to `true`.
 To configure system proxy servers, set some or all of the following properties:

diff --git a/docs/modules/operation/pages/deep-dive/admin/housekeeping.adoc b/docs/modules/operation/pages/deep-dive/admin/housekeeping.adoc
@@ -1,5 +1,6 @@
 
 = Housekeeping Tasks
+:description: Read about recommended housekeeping tasks to complete to ensure optimum system performance with OpenNMS Horizon/Meridian, and to perform before upgrading.
 
 This section describes housekeeping tasks that you may want to perform to ensure optimum system performance.
 We recommend that you complete some of these tasks before upgrading your {page-component-title} instance.

diff --git a/docs/modules/operation/pages/deep-dive/admin/jmx-config-generator/cli.adoc b/docs/modules/operation/pages/deep-dive/admin/jmx-config-generator/cli.adoc
@@ -1,5 +1,6 @@
 
 = CLI-Based Utility
+:description: Learn how to install and use the command line-based JMX Configuration Generator generator tool with OpenNMS Horizon/Meridian (Debian and RPM).
 
 The JMX Configuration Generator command line-based (CLI) tool is not installed by default.
 ifeval::["{page-component-name}" == "meridian"]

diff --git a/.../modules/operation/pages/deep-dive/admin/jmx-config-generator/introduction.adoc b/.../modules/operation/pages/deep-dive/admin/jmx-config-generator/introduction.adoc
@@ -1,5 +1,6 @@
 
 = JMX Configuration Generator
+:description: Learn how the JMX Configuration Generator generates valid, complex JMX data collection configuration and RRD graph definitions for OpenNMS Horizon/Meridian.
 
 {page-component-title} implements the JMX protocol to collect long-term performance data for Java applications.
 There are a wide variety of metrics available, and administrators have to select which information to collect.

diff --git a/docs/modules/operation/pages/deep-dive/admin/jmx-config-generator/webui.adoc b/docs/modules/operation/pages/deep-dive/admin/jmx-config-generator/webui.adoc
@@ -1,5 +1,6 @@
 
 = Web-Based Utility
+:description: Learn how to configure and use the web-based JMX Configuration Generator generator tool with OpenNMS Horizon/Meridian.
 
 Complex JMX data collection configurations can be generated using the web-based tool.
 

diff --git a/docs/modules/operation/pages/deep-dive/admin/logging/introduction.adoc b/docs/modules/operation/pages/deep-dive/admin/logging/introduction.adoc
@@ -1,5 +1,6 @@
 
 = Logging
+:description: Learn how logging works in OpenNMS Horizon/Meridian, including logging level options.
 
 {page-component-title} stores logs under the name of the daemon that was acting on a process (for example, logs for xref:deep-dive/service-assurance/introduction.adoc[service assurance checks] that are run by pollerd are stored in `pollerd.log`).
 Log files are available in `$\{OPENNMS_HOME}/logs`, which is a symlink to `/var/log/opennms`.

diff --git a/docs/modules/operation/pages/deep-dive/admin/logging/log-file-viewer.adoc b/docs/modules/operation/pages/deep-dive/admin/logging/log-file-viewer.adoc
@@ -1,5 +1,6 @@
 
 = Log File Viewer
+:description: Learn how to view log files in the OpenNMS Horizon/Meridian web UI.
 
 You can view log files in the {page-component-title} web UI.
 To do so, click menu:Info[Logs] in the top menu bar.

diff --git a/docs/modules/operation/pages/deep-dive/admin/logging/log-reader.adoc b/docs/modules/operation/pages/deep-dive/admin/logging/log-reader.adoc
@@ -1,5 +1,6 @@
 
 = Instrumentation Log Reader
+:description: Learn how to use the instrumentation log reader to view how long data collection takes for each node in OpenNMS Horizon/Meridian.
 
 The instrumentation log reader provides information on how long data collection takes for each node in the system, and which nodes are taking the most time.
 You can view this information in the Instrumentation Log Statistics UI:

diff --git a/docs/modules/operation/pages/deep-dive/admin/mib.adoc b/docs/modules/operation/pages/deep-dive/admin/mib.adoc
@@ -1,5 +1,6 @@
 
 = SNMP MIB Compiler
+:description: Learn how to import a MIB file and create event definitions in OpenNMS Horizon/Meridian.
 
 Management Information Base (MIB) files are text files written in https://en.wikipedia.org/wiki/ASN.1[Abstract Syntax Notation].
 They describe Simple Network Management Protocol (SNMP) elements for specific devices.

diff --git a/docs/modules/operation/pages/deep-dive/admin/restart.adoc b/docs/modules/operation/pages/deep-dive/admin/restart.adoc
@@ -1,5 +1,6 @@
 
 = Shutdown and Restart {page-component-title}
+:description: Learn the recommended order to shut down and restart components in OpenNMS Horizon/Meridian: core, persistence/messaging, and database layers.
 
 This section provides an example of the order to follow when shutting down and restarting a sample {page-component-title} system: {page-component-title} core layer, persistence and messaging layer, and database layer.
 

diff --git a/docs/modules/operation/pages/deep-dive/visualizations/surveillance-view.adoc b/docs/modules/operation/pages/deep-dive/visualizations/surveillance-view.adoc
@@ -1,5 +1,6 @@
 
 = Surveillance View
+:description: Get an overview of the surveillance view in OpenNMS Horizon/Meridian including the matrix display and custom configuration.
 
 The surveillance view displays an overview of your monitored network's status, and serves as the foundation of the xref:deep-dive/visualizations/dashboard.adoc[{page-component-title} dashboard].
 You can filter and customize the data displayed as desired.

diff --git a/docs/modules/operation/pages/deep-dive/visualizations/trends.adoc b/docs/modules/operation/pages/deep-dive/visualizations/trends.adoc
@@ -1,5 +1,6 @@
 
 = Trend
+:description: Learn how to use the Trend feature in OpenNMS Horizon/Meridian to visualize smal inline charts of database-related statistics like node outages.
 
 The Trend feature visualizes small, inline charts of database-related statistics (nodes experiencing outages, unacknowledged alarms, and so on).
 Click menu:Status[Trend] in the top menu bar to view them.