Merge branch 'main' into docs/physical-backup-csi-config

Author: mariadb-mmontes

maxscale/maxscale-architecture/README.md

@@ -1,8 +1,8 @@
 ---
 description: >-
-  Understand MariaDB MaxScale's architecture. Explore its components, including
-  monitors, routers, and filters, and how they work together to provide advanced
-  database proxy capabilities.
+  Understand the architecture of MariaDB MaxScale. This section details the core
+  components, including routers, monitors, and filters, that power the database
+  proxy.
 icon: house-blank
 ---
 

maxscale/maxscale-architecture/mariadb-maxscale-guide.md

@@ -1,51 +1,35 @@
+---
+description: >-
+  Learn the fundamental concepts of MariaDB MaxScale. This guide explains its
+  role as a database proxy, its plugin-based architecture, and how it manages
+  database connections.
+---
+
 # About MariaDB MaxScale
 
 ## About MariaDB MaxScale
 
-**MariaDB MaxScale** is a database proxy that forwards database statements to
-one or more database servers.
+**MariaDB MaxScale** is a database proxy that forwards database statements to one or more database servers.
 
-The forwarding is performed using rules based on the semantic understanding of
-the database statements and on the roles of the servers within the backend
-cluster of databases.
+The forwarding is performed using rules based on the semantic understanding of the database statements and on the roles of the servers within the backend cluster of databases.
 
-MariaDB MaxScale is designed to provide, transparently to applications, load
-balancing and high availability functionality. MariaDB MaxScale has a scalable
-and flexible architecture, with plugin components to support different protocols
-and routing approaches.
+MariaDB MaxScale is designed to provide transparent to applications, load balancing and high availability functionality. MariaDB MaxScale has a scalable and flexible architecture, with plugin components to support different protocols and routing approaches.
 
-MariaDB MaxScale makes extensive use of the asynchronous I/O capabilities of the
-Linux operating system, combined with a fixed number of worker threads. _epoll_
-is used to provide the event driven framework for the input and output via
-sockets.
+MariaDB MaxScale makes extensive use of the asynchronous I/O capabilities of the Linux operating system, combined with a fixed number of worker threads. _epoll_ is used to provide an event-driven framework for the input and output via sockets.
 
-Many of the services provided by MariaDB MaxScale are implemented as external
-shared object modules loaded at runtime. These modules support a fixed
-interface, communicating the entry points via a structure consisting of a set of
-function pointers. This structure is called the "module object". Additional
-modules can be created to work with MariaDB MaxScale.
+Many of the services provided by MariaDB MaxScale are implemented as external shared object modules loaded at runtime. These modules support a fixed interface, communicating the entry points via a structure consisting of a set of function pointers. This structure is called the "module object". Additional modules can be created to work with MariaDB MaxScale.
 
-Commonly used module types are _protocol_, _router_ and _filter_. Protocol
-modules implement the communication between clients and MariaDB MaxScale, and
-between MariaDB MaxScale and backend servers. Routers inspect the queries from
-clients and decide the target backend. The decisions are usually based on
-routing rules and backend server status. Filters work on data as it passes
-through MariaDB MaxScale. Filter are often used for logging queries or modifying
-server responses.
+Commonly used module types are _protocol_, _router,_ and _filter_. Protocol modules implement the communication between clients and MariaDB MaxScale, and between MariaDB MaxScale and backend servers. Routers inspect the queries from clients and decide the target backend. The decisions are usually based on routing rules and backend server status. Filters work on data as it passes through MariaDB MaxScale. Filters are often used for logging queries or modifying server responses.
 
-A Google Group exists for MariaDB MaxScale. The Group is used to discuss ideas,
-issues and communicate with the MariaDB MaxScale community. Send email to [[email protected]](mailto:[email protected]) or use the [forum](https://groups.google.com/forum/#!forum/maxscale) interface.
+A Google Group exists for MariaDB MaxScale. The Group is used to discuss ideas, issues, and communicate with the MariaDB MaxScale community. Send an email to [[email protected]](mailto:[email protected]) or use the [forum](https://groups.google.com/forum/#!forum/maxscale) interface.
 
 Bugs can be reported in the MariaDB Jira [jira.mariadb.org](https://jira.mariadb.org)
 
 ### Installing MariaDB MaxScale
 
-Information about installing MariaDB MaxScale, either from a repository or by
-building from source code, is included in the [MariaDB MaxScale Installation
-Guide](../maxscale-management/installation-and-configuration/maxscale-installation-guide.md).
+Information about installing MariaDB MaxScale, either from a repository or by building from source code, is included in the [MariaDB MaxScale Installation Guide](../maxscale-management/installation-and-configuration/maxscale-installation-guide.md).
 
-The same guide also provides basic information on running MariaDB MaxScale. More
-detailed information about configuring MariaDB MaxScale can be found in the [Configuration Guide](../maxscale-management/deployment/maxscale-configuration-guide.md).
+The same guide also provides basic information on running MariaDB MaxScale. More detailed information about configuring MariaDB MaxScale can be found in the [Configuration Guide](../maxscale-management/deployment/maxscale-configuration-guide.md).
 
 <sub>_This page is licensed: CC BY-SA / Gnu FDL_</sub>
 

maxscale/maxscale-architecture/mariadb-maxscale-overview.md

@@ -1,8 +1,8 @@
 ---
 description: >-
-  Get an overview of MariaDB MaxScale. This section introduces its core
-  functionalities, including intelligent routing, load balancing, and high
-  availability, for managing and optimizing deployment.
+  Get a high-level view of MariaDB MaxScale features. Explore how it handles
+  load balancing, high availability, and security to optimize your database
+  infrastructure.
 ---
 
 # MariaDB MaxScale Overview
@@ -11,40 +11,23 @@ description: >-
 
 MariaDB MaxScale is an advanced proxy, router, and load balancer:
 
-* MaxScale performs automated failover for MariaDB replication. When the primary
-  server fails, MaxScale promotes a replica to be the new primary and redirects
-  the remaining replicas to it.
-* MaxScale's ReadWriteSplit router performs query-based load balancing.
-  ReadWriteSplit routes each write statement to the current primary server
-  and load balances read statements by routing them to the replica servers.
-* MaxScale's ReadConnRoute router performs connection-based load balancing.
-  ReadConnRoute routes each connection to a single primary or replica node,
-  depending on configuration.
-* MaxScale can import data from Kafka and export data into Kafka. MaxScale's
-  KafkaCDC router streams data from MariaDB database products to a Kafka broker.
-  MaxScale's KafkaImporter router streams data from Kafka to MariaDB database products.
-* MaxScale provides built-in mechanisms to perform server maintenance without
-  disrupting applications or clients. Servers can be set to maintenance mode
-  using the command-line interface with MaxCtrl, a web browser with MaxGUI, or REST API.
+* MaxScale performs automated failover for MariaDB replication. When the primary server fails, MaxScale promotes a replica to be the new primary and redirects the remaining replicas to it.
+* MaxScale's ReadWriteSplit router performs query-based load balancing. ReadWriteSplit routes each write statement to the current primary server and load balances read statements by routing them to the replica servers.
+* MaxScale's ReadConnRoute router performs connection-based load balancing. ReadConnRoute routes each connection to a single primary or replica node, depending on configuration.
+* MaxScale can import data from Kafka and export data into Kafka. MaxScale's KafkaCDC router streams data from MariaDB database products to a Kafka broker. MaxScale's KafkaImporter router streams data from Kafka to MariaDB database products.
+* MaxScale provides built-in mechanisms to perform server maintenance without disrupting applications or clients. Servers can be set to maintenance mode using the command-line interface with MaxCtrl, a web browser with MaxGUI, or REST API.
 * MaxScale's Cache filter can improve SELECT performance by caching and reusing results.
-* Security and traffic controls for database connections and queries can be implemented
-  with MaxScale. MaxScale's QLAfilter can be used to create an audit trail by logging
-  all queries. MaxScale's RegexFilter can also perform audit logging or protect
-  against SQL injection by matching queries against a regular expression and
-  performing various actions on the query, such as logging it, modifying it, or
-  routing it to a specific server.
+* Security and traffic controls for database connections and queries can be implemented with MaxScale. MaxScale's QLAfilter can be used to create an audit trail by logging all queries. MaxScale's RegexFilter can also perform audit logging or protect against SQL injection by matching queries against a regular expression and performing various actions on the query, such as logging it, modifying it, or routing it to a specific server.
 
 MariaDB MaxScale can be deployed in the cloud or on-premises.
 
 ## Scheduled Releases
 
-MariaDB MaxScale follows the MariaDB Enterprise release schedule, which can be found
-[here](../../release-notes/enterprise-server/enterprise-server-release-schedule.md).
+MariaDB MaxScale follows the MariaDB Enterprise release schedule, which can be found [here](../../release-notes/enterprise-server/enterprise-server-release-schedule.md).
 
 ## Software Releases
 
-The supported MaxScale versions can be found from the latest
-[MariaDB Engineering Policy](https://mariadb.com/engineering-policies/).
+The supported MaxScale versions can be found in the latest [MariaDB Engineering Policy](https://mariadb.com/engineering-policies/).
 
 <sub>_This page is: Copyright © 2025 MariaDB. All rights reserved._</sub>
 

maxscale/maxscale-quickstart-guides/README.md

@@ -1,7 +1,8 @@
 ---
 description: >-
   Get started with MariaDB MaxScale, the advanced database proxy. These guides
-  provide a quick path to installing, configuring, and leveraging key features.
+  provide concise instructions for installation, configuration, and
+  understanding core concepts for new deployments.
 icon: rabbit-running
 ---
 

maxscale/maxscale-quickstart-guides/mariadb-maxscale-authenticators-guide.md

@@ -1,5 +1,8 @@
 ---
-description: Quickstart guide for MariaDB MaxScale authentication modules
+description: >-
+  Configure secure access to your database. This guide explains how to set up
+  authenticators in MaxScale to manage client credentials and validate
+  connections to backend servers.
 ---
 
 # MariaDB MaxScale Authenticators Guide

maxscale/maxscale-quickstart-guides/mariadb-maxscale-guide.md

@@ -1,5 +1,8 @@
 ---
-description: Quickstart guide for MariaDB MaxScale
+description: >-
+  Discover the capabilities of MariaDB MaxScale. This overview explains how the
+  proxy manages high availability, load balancing, and security for your
+  database infrastructure.
 ---
 
 # MariaDB MaxScale Guide

maxscale/maxscale-quickstart-guides/mariadb-maxscale-installation-guide.md

@@ -1,5 +1,8 @@
 ---
-description: MariaDB MaxScale installation quickstart guide
+description: >-
+  Follow step-by-step instructions to install MariaDB MaxScale on major Linux
+  distributions. This guide covers repository configuration and package
+  installation.
 ---
 
 # MariaDB MaxScale Installation Guide
@@ -10,7 +13,7 @@ MariaDB MaxScale is an advanced, open-source database proxy that provides intell
 
 {% stepper %}
 {% step %}
-#### Key concepts
+**Key concepts**
 
 To understand MaxScale, familiarize yourself with these core components:
 
@@ -23,7 +26,7 @@ To understand MaxScale, familiarize yourself with these core components:
 {% endstep %}
 
 {% step %}
-#### Installation
+**Installation**
 
 MariaDB MaxScale is typically installed from the official MariaDB repositories.
 
@@ -49,7 +52,7 @@ sudo dnf install -y maxscale
 {% endstep %}
 
 {% step %}
-#### Basic configuration
+**Basic configuration**
 
 MaxScale's configuration is primarily done in its main configuration file in `/etc/maxscale.cnf`.
 
@@ -152,7 +155,7 @@ threads=auto
 {% endstep %}
 
 {% step %}
-#### Complete configuration
+**Complete configuration**
 
 Your `/etc/maxscale.cnf` should now look like this:
 
@@ -192,7 +195,7 @@ port=3306
 {% endstep %}
 
 {% step %}
-#### Start and enable MaxScale
+**Start and enable MaxScale**
 
 After configuring `maxscale.cnf`, start and enable the MaxScale service.
 
@@ -204,7 +207,7 @@ sudo systemctl status maxscale # Check status
 {% endstep %}
 
 {% step %}
-#### Basic usage and verification
+**Basic usage and verification**
 
 Once MaxScale is running, configure your applications to connect to MaxScale's listener port instead of directly to a MariaDB server.
 

maxscale/maxscale-quickstart-guides/mariadb-maxscale-limitations-guide.md

@@ -1,5 +1,8 @@
 ---
-description: MariaDB MaxScale limitations quickstart guide
+description: >-
+  Review known limitations and constraints of MariaDB MaxScale. Understand
+  supported features, configuration boundaries, and protocol specifics to plan
+  your deployment effectively.
 ---
 
 # MariaDB MaxScale Limitations Guide