From 3e87e788e55f74092c908e3d5e8a5019bf1a0016 Mon Sep 17 00:00:00 2001 From: Bonrob2 <59453630+Bonrob2@users.noreply.github.com> Date: Fri, 30 Jun 2023 16:42:41 -0400 Subject: [PATCH] DP-58: Fix internal HTTP links Updated internal links that pointed to HTTP. DP-63: Add meta descriptions to each page in the deployment guide - began to add descriptions for better SEO. --- docs/modules/deployment/pages/core/admin-password-reset.adoc | 1 + docs/modules/deployment/pages/core/getting-started.adoc | 1 + docs/modules/deployment/pages/core/introduction.adoc | 1 + docs/modules/deployment/pages/core/setup-message-broker.adoc | 1 + docs/modules/deployment/pages/core/system-requirements.adoc | 1 + docs/modules/deployment/pages/minion/install.adoc | 1 + .../deployment/pages/minion/installing-jdbc-driver.adoc | 1 + docs/modules/deployment/pages/minion/introduction.adoc | 1 + docs/modules/deployment/pages/minion/off-heap-storage.adoc | 3 ++- docs/modules/deployment/pages/minion/system-requirements.adoc | 1 + docs/modules/development/pages/rest/CORS.adoc | 4 ++-- 11 files changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/modules/deployment/pages/core/admin-password-reset.adoc b/docs/modules/deployment/pages/core/admin-password-reset.adoc index 1214ea4d26d0..dbac87ee0151 100644 --- a/docs/modules/deployment/pages/core/admin-password-reset.adoc +++ b/docs/modules/deployment/pages/core/admin-password-reset.adoc @@ -1,6 +1,7 @@ [[reset-admin-password]] = Reset the Web UI Admin Password +:description: Learn how to reset your OpenNMS Admin password on the command line. This section explains how to set the web UI admin password using the {page-component-title} installation script. diff --git a/docs/modules/deployment/pages/core/getting-started.adoc b/docs/modules/deployment/pages/core/getting-started.adoc index ef32f06f1c90..019ba54b6fd2 100644 --- a/docs/modules/deployment/pages/core/getting-started.adoc +++ b/docs/modules/deployment/pages/core/getting-started.adoc @@ -1,6 +1,7 @@ [[getting-started-core]] = Installation and Configuration +:description: Install and configure OpenNMS instance including PostgreSQL set up on CentOS/RHEL 7-9, Debian/Ubuntu, and Docker. This section explains how to install and configure a new {page-component-title} instance. It describes how to do the following tasks: diff --git a/docs/modules/deployment/pages/core/introduction.adoc b/docs/modules/deployment/pages/core/introduction.adoc index e61a3ede6e8f..114a9b1e0231 100644 --- a/docs/modules/deployment/pages/core/introduction.adoc +++ b/docs/modules/deployment/pages/core/introduction.adoc @@ -1,6 +1,7 @@ [[basic-deployment]] = OpenNMS {page-component-title} +:description: OpenNMS installation overview: PostgreSQL, REST endpoints, monitoring functions, provisioning, and web interface. OpenNMS architecture diagram. A basic {page-component-title} deployment installs and configures the core software, which includes PostgreSQL, REST endpoints, monitoring functions, provisioning, and the web interface. It also includes a set of xref:reference:daemons/introduction.adoc[daemons] for specific network management use cases. diff --git a/docs/modules/deployment/pages/core/setup-message-broker.adoc b/docs/modules/deployment/pages/core/setup-message-broker.adoc index ed9f2fe44e82..cd19dfc64e8c 100644 --- a/docs/modules/deployment/pages/core/setup-message-broker.adoc +++ b/docs/modules/deployment/pages/core/setup-message-broker.adoc @@ -1,5 +1,6 @@ [[setup-message-broker]] = Set up Message Broker +:description: Learn how to set up and configure the following message brokers in OpenNMS: Kafka, ActiveMQ, Embedded ActiveMQ, and gRPC. Distributing {page-component-title} components like Minions and Sentinel require a messaging infrastructure. This section describes how to set up your {page-component-title} Core instance to use an existing messaging infrastructure based on ActiveMQ or Apache Kafka. diff --git a/docs/modules/deployment/pages/core/system-requirements.adoc b/docs/modules/deployment/pages/core/system-requirements.adoc index 3bee7cda4121..4292e0b3dab3 100644 --- a/docs/modules/deployment/pages/core/system-requirements.adoc +++ b/docs/modules/deployment/pages/core/system-requirements.adoc @@ -1,5 +1,6 @@ = Minimum System Requirements +:description: OpenNMS system requirements, supported operating systems, version compatibility with Grafana, Cassandra, Elasticsearch, JDK, Kafka, PostgreSQL. Your system must meet the following minimum specifications to run {page-component-title}: diff --git a/docs/modules/deployment/pages/minion/install.adoc b/docs/modules/deployment/pages/minion/install.adoc index 286463e82922..a3a94232ea87 100644 --- a/docs/modules/deployment/pages/minion/install.adoc +++ b/docs/modules/deployment/pages/minion/install.adoc @@ -1,6 +1,7 @@ [[install-minion]] = Install Minion +:description: How to install OpenNMS Minion on CentOS/RHEL 7-9, Debian/Ubuntu, Docker, and configure with message brokers: Kafka, ActiveMQ, Embedded ActiveMQ, gRPC. [[objectives]] == Objectives diff --git a/docs/modules/deployment/pages/minion/installing-jdbc-driver.adoc b/docs/modules/deployment/pages/minion/installing-jdbc-driver.adoc index 685a23830bfd..41cedded9abb 100644 --- a/docs/modules/deployment/pages/minion/installing-jdbc-driver.adoc +++ b/docs/modules/deployment/pages/minion/installing-jdbc-driver.adoc @@ -1,6 +1,7 @@ [[install-jdbc-driver]] = Install JDBC Driver on Minion +:description: How to install JDBC driver on an OpenNMS Minion with MySQL and Karaf. To detect, poll, or collect any JDBC service, you must install the corresponding JDBC driver. diff --git a/docs/modules/deployment/pages/minion/introduction.adoc b/docs/modules/deployment/pages/minion/introduction.adoc index 913de6711a01..d26277c11316 100644 --- a/docs/modules/deployment/pages/minion/introduction.adoc +++ b/docs/modules/deployment/pages/minion/introduction.adoc @@ -1,5 +1,6 @@ = Minion +:description: Learn about the OpenNMS Minion: benefits, how it works, with architecture diagram with three Minions. A Minion is an instance of the Karaf OSGi runtime that enables {page-component-title} to monitor devices and services in locations that it otherwise cannot reach. Minions communicate with these remote devices while {page-component-title} performs coordination and task delegation. diff --git a/docs/modules/deployment/pages/minion/off-heap-storage.adoc b/docs/modules/deployment/pages/minion/off-heap-storage.adoc index a21eb3027870..48691d581557 100644 --- a/docs/modules/deployment/pages/minion/off-heap-storage.adoc +++ b/docs/modules/deployment/pages/minion/off-heap-storage.adoc @@ -1,7 +1,8 @@ = Off-heap storage +:description: Off-heap storage with the OpenNMS Minion. If a Minion loses connectivity with the broker (Kafka or ActiveMQ), then any received messages (syslog, flows, SNMP traps) are queued until connectivity is restored. -This queue is limited by a fixed (and configurable) number of messages queued in the JVM heap and can optionally queue additional messages by persisting directly to the file system, avoiding heap memory use. +This queue is limited by a fixed (and configurable) number of messages queued in the JVM heap and can optionally queue additional messages by persisting directly to the file system, avoiding heap memory use. Once the queue is full, additional messages are dropped. The off-heap storage feature lets you extend the storage capacity by queuing messages outside of the JVM heap. diff --git a/docs/modules/deployment/pages/minion/system-requirements.adoc b/docs/modules/deployment/pages/minion/system-requirements.adoc index f27ffeb8eba4..a8f9c3c1690a 100644 --- a/docs/modules/deployment/pages/minion/system-requirements.adoc +++ b/docs/modules/deployment/pages/minion/system-requirements.adoc @@ -1,6 +1,7 @@ [[system-requirements-minion]] = Minimum System Requirements +:description: Minimum requirements for OpenNMS Minion, including operating systems. The following hardware specs are the minimum required to run a Minion: diff --git a/docs/modules/development/pages/rest/CORS.adoc b/docs/modules/development/pages/rest/CORS.adoc index a544e3a63ffd..fa53710ad96a 100644 --- a/docs/modules/development/pages/rest/CORS.adoc +++ b/docs/modules/development/pages/rest/CORS.adoc @@ -9,12 +9,12 @@ This section describes CORS (Cross-Origin Resource Sharing), a standard mechanis By default, many browsers implement a same origin policy, which prevents making requests to a resource on an origin that's different from the source origin. -For example, a request originating from a page served from http://www.opennms.com to a resource on http://www.adventuresinoss.com would be considered a cross-origin request. +For example, a request originating from a page served from https://www.opennms.com to a resource on https://www.adventuresinoss.com would be considered a cross-origin request. For further details, see: * https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS[Mozilla's HTTP access control (CORS)] -* http://www.w3.org/TR/cors/[W3C's CORS Specification] +* https://www.w3.org/TR/cors/[W3C's CORS Specification] == How can I enable CORS support?