PXC-4580 [DOCS] - Add Get more help to 8.4 (#189)

new file: docs/_static/groups.svg modified: docs/apt.md modified: docs/docker.md new file: docs/get-help.md modified: docs/install-index.md modified: docs/yum.md modified: mkdocs-base.yml new file: snippets/get-help-snip.md Co-authored-by: Alina Derkach <[email protected]>
percona · Jan 21, 2025 · b000535 · b000535
1 parent 88f4286
commit b000535
Show file tree

Hide file tree

Showing 10 changed files with 26 additions and 17 deletions.
diff --git a/docs/_static/groups.svg b/docs/_static/groups.svg
diff --git a/docs/apt.md b/docs/apt.md
@@ -1,4 +1,4 @@
-# Install Percona XtraDB Cluster on Debian or Ubuntu
+# Install on Debian or Ubuntu
 
 Specific information on the supported platforms, products, and versions
 is described in [Percona Software and Platform Lifecycle](https://www.percona.com/services/policies/percona-software-platform-lifecycle#mysql).
@@ -10,6 +10,8 @@ using APT.
 
 We gather [Telemetry data] in the Percona packages and Docker images.
 
+--8<--- "get-help-snip.md"
+
 ## Prerequisites
 
 * You need to have root access on the node where you will be installing Percona XtraDB Cluster (either logged in as a user with root privileges or be able to run commands with sudo).
@@ -114,4 +116,4 @@ During the installation, you are requested to provide a password for the `root`
 After you install Percona XtraDB Cluster and stop the `mysql` service,
 configure the node according to the procedure described in [Configuring Nodes for Write-Set Replication](configure-nodes.md#configure).
 
-[Telemetry data]: telemetry.md
+[Telemetry data]: telemetry.md
diff --git a/docs/docker.md b/docs/docker.md
@@ -9,14 +9,9 @@ provided via `apt` and `yum` may be outdated and cause errors.
 
 We gather [Telemetry data] in the Percona packages and Docker images.
 
-!!! note
+--8<--- "get-help-snip.md"
 
-    By default, Docker pulls the image from Docker Hub if the image is not
-    available locally.
-
-    The image contains only the most essential binaries for Percona XtraDB Cluster to
-    run. Some utilities included in a Percona Server for MySQL or MySQL
-    installation might be missing from the Percona XtraDB Cluster Docker image.
+By default, Docker pulls the image from Docker Hub if the image is not available locally. The image contains only the most essential Percona XtraDB Cluster binaries. Utilities included in a Percona Server for MySQL or MySQL installation might be missing from this image.
 
 The following procedure describes how to set up a simple 3-node cluster
 for evaluation and testing purposes. Do not use these instructions in a
@@ -25,6 +20,7 @@ procedure are self-signed. For a
 production environment, you should generate and store the certificates to be used by Docker.
 
 In this procedure, all of the nodes run Percona XtraDB Cluster {{vers}} in separate containers on one host:
+{.power-number}
 
 1. Create a ~/pxc-docker-test/config directory.
 
@@ -155,4 +151,4 @@ To verify the cluster is available, do the following:
         59 rows in set (0.02 sec)
         ```
 
-[Telemetry data]: telemetry.md
+[Telemetry data]: telemetry.md
diff --git a/docs/install-index.md b/docs/install-index.md
@@ -5,8 +5,9 @@ and ensure that you have root access to the MySQL server on each one.
 
 We gather [Telemetry data] in the Percona packages and Docker images.
 
-It is recommended to install Percona XtraDB Cluster from official Percona software repositories
-using the corresponding package manager for your system:
+--8<--- "get-help-snip.md"
+
+We recommended installing Percona XtraDB Cluster from official Percona software repositories using the appropriate package manager for your system:
 
 * [Debian or Ubuntu](apt.md#apt)
 
@@ -16,9 +17,9 @@ using the corresponding package manager for your system:
 
     After installing Percona XtraDB Cluster the ``mysql`` service is *stopped* but *enabled* so that it may start the next time the system is restarted. The service starts if the the grastate.dat file exists and the value of ``seqno`` is not **-1**.
 
-    !!! admonition "See also"
+    !!! admonition "For more information"
 
-        More information about Galera state information in [Index of files created by PXC grastat.dat](wsrep-files-index.md#wsrep-file-index)
+        See the Galera state information in [Index of files created by PXC grastat.dat](wsrep-files-index.md#wsrep-file-index)
 
 ## Installation alternatives
 

diff --git a/docs/tarball.md b/docs/tarball.md
@@ -6,6 +6,8 @@ for manual installation.
 You can download the appropriate tarball package from
 [Percona Software Downloads](https://www.percona.com/downloads).
 
+--8<--- "get-help-snip.md"
+
 ### Version updates
 
 The version number in the tarball name must be substituted with

diff --git a/docs/upgrade-from-backup.md b/docs/upgrade-from-backup.md
@@ -4,6 +4,8 @@
 
 Use Percona XtraBackup to back up the source server data and restore the data to a target server, and then upgrade the server to a different version of Percona XtraDB Cluster.
 
+--8<--- "get-help-snip.md"
+
 [Downgrading is not supported](https://docs.percona.com/percona-server/8.0/downgrade.html).
 
 ## Restore a database with a different server version

diff --git a/docs/upgrade-guide.md b/docs/upgrade-guide.md
@@ -15,6 +15,8 @@ and variables mentioned in these documents when upgrading to Percona XtraDB Clus
 
 - [Upgrading from MySQL 5.7 to 8.0](https://dev.mysql.com/doc/refman/8.0/en/upgrading-from-previous-series.html)
 
+--8<--- "get-help-snip.md"
+
 ## Important changes in Percona XtraDB Cluster 8.0
 
 - [Upgrade Percona XtraDB Cluster](#upgrade-percona-xtradb-cluster)

diff --git a/docs/yum.md b/docs/yum.md
@@ -1,10 +1,12 @@
-# Install Percona XtraDB Cluster on Red Hat Enterprise Linux and CentOS
+# Install on Red Hat Enterprise Linux
 
 A list of the supported platforms by products and versions
 is available in [Percona Software and Platform Lifecycle](https://www.percona.com/services/policies/percona-software-platform-lifecycle#mysql).
 
 We gather [Telemetry data] in the Percona packages and Docker images.
 
+--8<--- "get-help-snip.md"
+
 You can install Percona XtraDB Cluster with the following methods:
 
 * Use the official repository using YUM
@@ -80,4 +82,4 @@ $ sudo service mysql stop
 
 Configure the node according to the procedure described in [Configuring Nodes for Write-Set Replication](configure-nodes.md#configure).
 
-[Telemetry data]: telemetry.md
+[Telemetry data]: telemetry.md
diff --git a/mkdocs-base.yml b/mkdocs-base.yml
@@ -145,7 +145,7 @@ extra:
 
 nav:
   - Home: index.md
-  - Get help from Percona: get-help.md
+      - get-help.md
   - Release notes:
       - Release notes index: release-notes/release-notes_index.md
       - release-notes/8.4.2-2.md 

diff --git a/snippets/get-help-snip.md b/snippets/get-help-snip.md
@@ -0,0 +1 @@
+Review [Get more help](get-help.md) for ways that we can work with you.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Review [Get more help](get-help.md) for ways that we can work with you.