Merge pull request #2 from percona/update-docs

Update the project
percona · Apr 17, 2024 · 47b8cb0 · 47b8cb0
2 parents d10e983 + 641f524
commit 47b8cb0
Show file tree

Hide file tree

Showing 12 changed files with 110 additions and 52 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,7 +2,6 @@ name: ci
 on:
   push:
     branches:
-      - master 
       - main
 permissions:
   contents: write

diff --git a/docs/test/ps-mysql.md → archived/ps-mysql.md b/docs/test/ps-mysql.md → archived/ps-mysql.md
diff --git a/docs/test/quickstart-guides.md → archived/quickstart-guides.md b/docs/test/quickstart-guides.md → archived/quickstart-guides.md
diff --git a/docs/dummy.md b/docs/dummy.md
diff --git a/docs/index.md b/docs/index.md
@@ -23,16 +23,16 @@ hide:
       <a href="percona-for-postgresql" class="splash-card">
         <img src="assets/logo-postgresql.svg" alt="Percona for PostgreSQL logo" />
         <h3>
-          Percona for PostgreSQL
-        </h3>
+         Percona Software for PostgreSQL    
+       </h3>
         <p>
           All Percona software for PostgreSQL databases documentation.
         </p>
       </a>
       <a href="percona-for-mongodb" class="splash-card">
         <img src="assets/logo-mongodb.svg" alt="Percona for MongoDB logo" />
         <h3>
-          Percona for MongoDB
+          Percona Software for MongoDB
         </h3>
         <p>
           All Percona software for MongoDB databases documentation.
@@ -41,7 +41,7 @@ hide:
       <a href="percona-for-mysql" class="splash-card">
         <img src="assets/logo-mysql.svg" alt="Percona for MySQL logo" />
         <h3>
-          Percona for MySQL
+          Percona Software for MySQL
         </h3>
         <p>
           All Percona software for MySQL databases documentation.
@@ -70,7 +70,7 @@ hide:
           Percona Everest
         </h3>
         <p>
-          Documentation for Percona’s private database-as-a-service open-source software.
+          Documentation for Percona’s cloud-native database platform.
         </p>
       </a>
       <a href="percona-operators" class="splash-card">

diff --git a/docs/percona-for-mongodb.md b/docs/percona-for-mongodb.md
@@ -10,7 +10,7 @@ hide:
 
 ![Percona for MongoDB logo](assets/logo-dark-mongodb.svg)
 
-# Percona for MongoDB
+# Percona Software for MongoDB
 
 Explore our Percona Software for MongoDB documentation. Find user guides, quickstarts, and how-tos tailored to help you build, deploy, manage, and automate MongoDB effectively.
 
@@ -26,12 +26,12 @@ Explore our Percona Software for MongoDB documentation. Find user guides, quicks
 
 ### <span style="font-size:1.875em;margin-right:0.125em">:percona-mongodb:</span> Percona Server for MongoDB {.title}
 
-An enhanced, fully compatible, source available, drop-in replacement for MongoDB Community Edition with enterprise-grade features.
+Please change the text to “An enhanced, fully compatible, source available, drop-in replacement for MongoDB Community Edition with [enterprise-grade features](https://docs.percona.com/percona-server-for-mongodb/7.0/comparison.html).
 
 <div class="actions" markdown>
 
-[Releases](#)
-[Quickstart Docs :material-arrow-right:](https://pmcf-percona.github.io/pbm-docs/)
+[Releases](https://docs.percona.com/percona-server-for-mongodb/7.0/release_notes/index.html)
+[Quickstart Docs :material-arrow-right:](https://docs.percona.com/percona-server-for-mongodb/7.0/install/index.html)
 
 </div>
 </div>
@@ -43,8 +43,8 @@ Based on best practices for the configuration of Percona Server for MongoDB, the
 
 <div class="actions" markdown>
 
-[Releases](#)
-[Quickstart Docs :material-arrow-right:](https://pmcf-percona.github.io/pbm-docs/)
+[Releases](https://docs.percona.com/percona-operator-for-mongodb/RN/index.html)
+[Quickstart Docs :material-arrow-right:](https://docs.percona.com/percona-operator-for-mongodb/quickstart.html)
 
 </div>
 </div>
@@ -56,8 +56,8 @@ An open source, community backup tool for performing consistent backups and rest
 
 <div class="actions" markdown>
 
-[Releases](#)
-[Quickstart Docs :material-arrow-right:](https://pmcf-percona.github.io/pbm-docs/)
+[Releases](https://docs.percona.com/percona-backup-mongodb/release-notes.html)
+[Quickstart Docs :material-arrow-right:](https://docs.percona.com/percona-backup-mongodb/installation.html)
 
 </div>
 </div>
@@ -69,16 +69,16 @@ A collection of solutions to run and operate your MongoDB efficiently with the d
 
 <div class="actions" markdown>
 
-[Releases](#)
-[Quickstart Docs :material-arrow-right:](https://pmcf-percona.github.io/pbm-docs/)
+[Releases](https://docs.percona.com/percona-distribution-for-mongodb/7.0/release-notes.html)
+[Documentation :material-arrow-right:](https://docs.percona.com/percona-distribution-for-mongodb/7.0/)
 
 </div>
 </div>
 <div data-banner markdown>
 
 ### <span style="font-size:1.875em;margin-right:0.0625em">:percona-pmm:</span> Monitoring MongoDB with PMM {.title}
 
-High-quality, polyglot monitoring, alerting and more functionalities for MongoDB and other database technologies.
+An open source database monitoring, management and observability solution for MongoDB and other database technologies.
 
 <div class="actions" markdown>
 

diff --git a/docs/percona-for-mysql.md b/docs/percona-for-mysql.md
@@ -10,7 +10,7 @@ hide:
 
 ![Percona for MySQL logo](assets/logo-dark-mysql.svg)
 
-# Percona for MySQL
+# Percona Software for MySQL
 
 Quickstart guides, user guides, and how-tos, release notes, and the latest downloads. Everything you need to optimize your MySQL databases is right here.
 
@@ -30,8 +30,8 @@ An enhanced, fully compatible, source available, drop-in replacement for MySQL C
 
 <div class="actions" markdown>
 
-[Releases](#)
-[Quickstart Docs :material-arrow-right:](https://pmcf-percona.github.io/pxb-docs/)
+[Releases](https://docs.percona.com/percona-server/innovation-release/release-notes/release-notes-index.html)
+[Quickstart Docs :material-arrow-right:](https://docs.percona.com/percona-server/innovation-release/quickstart-overview.html)
 
 </div>
 </div>
@@ -43,8 +43,8 @@ Automate deployment and management of MySQL clusters on Kubernetes with Operator
 
 <div class="actions" markdown>
 
-[Releases](#)
-[Quickstart Docs :material-arrow-right:](https://pmcf-percona.github.io/pxb-docs/)
+[Releases](https://docs.percona.com/percona-operator-for-mysql/ps/ReleaseNotes/index.html)
+[Quickstart Docs :material-arrow-right:](https://docs.percona.com/percona-operator-for-mysql/ps/quickstart.html)
 
 </div>
 </div>
@@ -57,8 +57,8 @@ It ensures high availability, prevents downtime and data loss, and provides line
 
 <div class="actions" markdown>
 
-[Releases](#)
-[Quickstart Docs :material-arrow-right:](https://pmcf-percona.github.io/pxb-docs/)
+[Releases](https://docs.percona.com/percona-xtradb-cluster/8.0/release-notes/release-notes_index.html)
+[Quickstart Docs :material-arrow-right:](https://docs.percona.com/percona-xtradb-cluster/8.0/quickstart-overview.html)
 
 </div>
 </div>
@@ -70,8 +70,8 @@ Automate deployment and management of Percona XtraDB Clusters (MySQL clustering
 
 <div class="actions" markdown>
 
-[Releases](#)
-[Quickstart Docs :material-arrow-right:](https://pmcf-percona.github.io/pxb-docs/)
+[Releases](https://docs.percona.com/percona-operator-for-mysql/pxc/ReleaseNotes/index.html)
+[Quickstart Docs :material-arrow-right:](https://docs.percona.com/percona-operator-for-mysql/pxc/quickstart.html)
 
 </div>
 </div>
@@ -83,8 +83,8 @@ An open source, hot backup utility for MySQL-based servers that keeps your datab
 
 <div class="actions" markdown>
 
-[Releases](#)
-[Quickstart Docs :material-arrow-right:](https://pmcf-percona.github.io/pxb-docs/)
+[Releases](https://docs.percona.com/percona-xtrabackup/innovation-release/release-notes/release-notes.html)
+[Quickstart Docs :material-arrow-right:](https://docs.percona.com/percona-xtrabackup/innovation-release/quickstart-overview.html)
 
 </div>
 </div>
@@ -96,8 +96,8 @@ A single solution with the best and most critical enterprise components from the
 
 <div class="actions" markdown>
 
-[Releases](#)
-[Quickstart Docs :material-arrow-right:](https://pmcf-percona.github.io/pxb-docs/)
+[Releases](https://docs.percona.com/percona-distribution-for-mysql/innovation-release/)
+[Documentation :material-arrow-right:](https://docs.percona.com/percona-distribution-for-mysql/innovation-release/)
 
 </div>
 </div>
@@ -109,7 +109,8 @@ Use ProxySQL Admin to configure Percona XtraDB Cluster nodes into ProxySQL. The
 
 <div class="actions" markdown>
 
-[Documentation :material-arrow-right:](#)
+[Releases](https://docs.percona.com/proxysql/release-notes.html)
+[Documentation :material-arrow-right:](https://docs.percona.com/proxysql/)
 
 </div>
 </div>

diff --git a/docs/percona-for-postgresql.md b/docs/percona-for-postgresql.md
@@ -10,7 +10,7 @@ hide:
 
 ![Percona for PostgreSQL logo](assets/logo-dark-postgresql.svg)
 
-# Percona for PostgreSQL
+# Percona Software for PostgreSQL
 
 Explore our Percona Software for PostgreSQL documentation. Find user guides, quickstarts, and how-tos tailored to help you build, deploy, manage, and automate PostgreSQL effectively.
 
@@ -30,8 +30,8 @@ A native PostgreSQL server enhanced with the set of extensions for high availabi
 
 <div class="actions" markdown>
 
-[Releases](#)
-[Quickstart Docs :material-arrow-right:](https://pmcf-percona.github.io/postgresql-docs/)
+[Releases](https://docs.percona.com/postgresql/16/release-notes.html)
+[Documentation :material-arrow-right:](https://docs.percona.com/postgresql/16/)
 
 </div>
 </div>
@@ -43,8 +43,8 @@ Automate deployment and management of PostgreSQL clusters on Kubernetes with Ope
 
 <div class="actions" markdown>
 
-[Releases](#)
-[Quickstart Docs :material-arrow-right:](https://pmcf-percona.github.io/postgresql-docs/)
+[Releases](https://docs.percona.com/percona-operator-for-postgresql/2.0/ReleaseNotes/index.html)
+[Quickstart Docs :material-arrow-right:](https://docs.percona.com/percona-operator-for-postgresql/2.0/quickstart.html)
 
 </div>
 </div>
@@ -56,8 +56,8 @@ A query performance monitoring tool that brings more insight and details around
 
 <div class="actions" markdown>
 
-[Releases](#)
-[Quickstart Docs :material-arrow-right:](https://pmcf-percona.github.io/postgresql-docs/)
+[Releases](https://docs.percona.com/pg-stat-monitor/release-notes/release_notes.html)
+[Documentation :material-arrow-right:](https://docs.percona.com/pg-stat-monitor/index.html)
 
 </div>
 </div>

diff --git a/docs/percona-operators.md b/docs/percona-operators.md
@@ -30,8 +30,8 @@ Automate deployment and management of PostgreSQL clusters on Kubernetes with Ope
 
 <div class="actions" markdown>
 
-[Releases](#)
-[Quickstart Docs :material-arrow-right:](https://pmcf-percona.github.io/k8spg-docs/)
+[Releases](https://docs.percona.com/percona-operator-for-postgresql/2.0/ReleaseNotes/index.html)
+[Quickstart Docs :material-arrow-right:](https://docs.percona.com/percona-operator-for-postgresql/2.0/quickstart.html)
 
 </div>
 </div>
@@ -43,8 +43,8 @@ Based on best practices for the configuration of Percona Server for MongoDB, the
 
 <div class="actions" markdown>
 
-[Releases](#)
-[Quickstart Docs :material-arrow-right:](https://pmcf-percona.github.io/k8spg-docs/)
+[Releases](https://docs.percona.com/percona-operator-for-mongodb/RN/index.html)
+[Quickstart Docs :material-arrow-right:](https://docs.percona.com/percona-operator-for-mongodb/quickstart.html)
 
 </div>
 </div>
@@ -56,8 +56,8 @@ Automate deployment and management of MySQL clusters on Kubernetes with Operator
 
 <div class="actions" markdown>
 
-[Releases](#)
-[Quickstart Docs :material-arrow-right:](https://pmcf-percona.github.io/k8spg-docs/)
+[Releases](https://docs.percona.com/percona-operator-for-mysql/ps/ReleaseNotes/index.html)
+[Quickstart Docs :material-arrow-right:](https://docs.percona.com/percona-operator-for-mysql/ps/quickstart.html)
 
 </div>
 </div>
@@ -69,8 +69,8 @@ Automate deployment and management of Percona XtraDB Clusters (MySQL clustering
 
 <div class="actions" markdown>
 
-[Releases](#)
-[Quickstart Docs :material-arrow-right:](https://pmcf-percona.github.io/k8spg-docs/)
+[Releases](https://docs.percona.com/percona-operator-for-mysql/pxc/ReleaseNotes/index.html)
+[Quickstart Docs :material-arrow-right:](https://docs.percona.com/percona-operator-for-mysql/pxc/quickstart.html)
 
 </div>
 </div>

diff --git a/docs/percona-utilities.md b/docs/percona-utilities.md
@@ -0,0 +1,61 @@
+---
+hide:
+- feedback
+- navigation
+- toc
+---
+
+<div class="landing" markdown>
+<div class="splash header subpage mysql dark" markdown>
+
+# Percona Utilities
+
+Tools and resources provided by Percona to enhance database management and performance.
+
+</div>
+</div>
+
+
+## Documentation
+
+<div data-grid markdown>
+<div data-banner markdown>
+
+### <span style="font-size:1.875em;margin-right:0.125em">:percona-logo:</span> Percona Toolkit {.title}
+
+Command-line tools for common MySQL database administration tasks.
+
+<div class="actions" markdown>
+
+[Releases](https://docs.percona.com/percona-toolkit/release_notes.html)
+[Documentation :material-arrow-right:](https://docs.percona.com/percona-toolkit/)
+
+</div>
+</div>
+<div data-banner markdown>
+
+### <span style="font-size:2em">:percona-pmm:</span> PMM Dump {.title}
+
+The utility performs a logical backup of the performance metrics, collected by the PMM Server and imports them into a different PMM Server instance. PMM Dump allows you to share monitoring data, collected by your PMM server, with Percona Support team securely.
+
+<div class="actions" markdown>
+
+[Releases](https://docs.percona.com/pmm-dump-documentation/ReleaseNotes/index.html)
+[Documentation :material-arrow-right:](https://docs.percona.com/pmm-dump-documentation/)
+
+</div>
+</div>
+<div data-banner markdown>
+
+### <span style="font-size:1.875em;margin-right:0.125em">:percona-logo:</span> Percona Software Repositories {.title}
+
+Binary and source packages of the latest official product releases as well as dedicated repositories for testing and experimental builds.
+
+<div class="actions" markdown>
+
+[Documentation :material-arrow-right:](https://docs.percona.com/percona-software-repositories/)
+
+</div>
+</div>
+</div>
+
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -88,7 +88,8 @@ nav:
   - MongoDB: percona-for-mongodb.md
   - MySQL: percona-for-mysql.md
   - Percona Operators: percona-operators.md
-  - Percona Everest: "https://pmcf-percona.github.io/everest-doc/"
-  - PMM: "https://pmcf-percona.github.io/pmm-doc/"
+  - Percona Everest: "https://docs.percona.com/everest/index.html"
+  - PMM: "https://docs.percona.com/percona-monitoring-and-management/index.html"
+  - Utilities: percona-utilities.md
   - Legacy docs: "https://docs.percona.com/legacy-documentation/"
   - Percona Lab: percona-lab.md
diff --git a/snippets/dummy.md b/snippets/dummy.md
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,6 @@ name: ci @@
     on:
       push:
         branches:
-          - master
           - main
     permissions:
       contents: write
@@ Expand Down @@