Merge pull request #512 from percona/ps-9812

PS-9812 [DOCS] - Add topic index 8.4

Author: patrickbirch

docs/index-contents.md

@@ -0,0 +1,205 @@
+# Index
+
+- [Adaptive network buffers](adaptive-network-buffers.md)
+- [Additional SELinux tools and management](additional-selinux-tools.md)
+- [AppArmor profile modes](apparmor-profiles.md)
+- [Apt pinning the Percona Server for MySQL {{vers}} packages](apt-pinning.md)
+- [Audit Log Filter compression and encryption](audit-log-filter-compression-encryption.md)
+- [Audit Log Filter file format overview](audit-log-filter-formats.md)
+- [Audit Log Filter file naming conventions](audit-log-filter-naming.md)
+- [Audit Log Filter format - JSON](audit-log-filter-json.md)
+- [Audit Log Filter format - XML (new style)](audit-log-filter-new.md)
+- [Audit Log Filter format - XML (old style)](audit-log-filter-old.md)
+- [Audit log filter functions, options, and variables](audit-log-filter-variables.md)
+- [Audit Log Filter overview](audit-log-filter-overview.md)
+- [Audit Log Filter restrictions](audit-log-filter-restrictions.md)
+- [Audit Log Filter security](audit-log-filter-security.md)
+- [Authentication methods](authentication-methods.md)
+- [Backup and restore overview](backup-restore-overview.md)
+- [Backup locks](backup-locks.md)
+- [Binary logs and replication improvements](binlogging-replication-improvements.md)
+- [Binary tarball file names available based on the Percona Server for MySQL version](binary-tarball-names.md)
+- [Build APT packages](build-apt-packages.md)
+- [Common data types](data-types-basic.md)
+- [Common SQL commands](common-sql.md)
+- [Common SQL errors](sql-errors.md)
+- [Compile Percona Server for MySQL from source](compile-percona-server.md)
+- [Compressed columns with dictionaries](compressed-columns.md)
+- [Configure AppArmor](configure-apparmor.md)
+- [Copyright and licensing information](copyright-and-licensing-information.md)
+- [Create a table](create-table.md)
+- [Data at Rest Encryption](data-at-rest-encryption.md)
+- [Data loading](myrocks-data-loading.md)
+- [Data masking component functions and variables](data-masking-function-list.md)
+- [Data masking overview](data-masking-overview.md)
+- [DELETE statement](delete.md)
+- [Development of Percona Server for MySQL](development.md)
+- [Differences between Percona MyRocks and Facebook MyRocks](myrocks-differences.md)
+- [Disable AppArmor](disable-apparmor.md)
+- [Disable Audit Log Filter logging](disable-audit-log-filter.md)
+- [Docker environment variables](docker-config.md)
+- [Downgrade from Percona Server for MySQL Pro](downgrade-from-pro.md)
+- [Downgrade Percona Server for MySQL](downgrade.md)
+- [Encrypt binary log files and relay log files](encrypt-binary-relay-log-files.md)
+- [Encrypt doublewrite file pages](encrypt-doublewrite-file-pages.md)
+- [Encrypt File-Per-Table Tablespace](encrypt-file-per-table-tablespace.md)
+- [Encrypt schema or general tablespace](encrypt-tablespaces.md)
+- [Encrypt system tablespace](encrypt-system-tablespace.md)
+- [Encrypt temporary files](encrypt-temporary-files.md)
+- [Encryption functions](encryption-functions.md)
+- [Enforcing storage engine](enforce-engine.md)
+- [Error handling in stored procedures](stored-procedure-error-handling.md)
+- [Expanded fast index creation](innodb-expanded-fast-index-creation.md)
+- [Extended mysqldump](extended-mysqldump.md)
+- [Extended SELECT INTO OUTFILE/DUMPFILE](extended-select-into-outfile.md)
+- [Extended SET VAR optimizer hint](extended-set-var.md)
+- [Extended show engine InnoDB status](innodb-show-status.md)
+- [FIDO authentication plugin](fido-authentication-plugin.md)
+- [Files in packages built for Percona Server for MySQL Pro](pro-files.md)
+- [Files in the DEB package built for Percona Server for MySQL {{vers}}](apt-files.md)
+- [Files in the RPM package built for Percona Server for MySQL {{vers}}](yum-files.md)
+- [Filter the Audit Log Filter logs](filter-audit-log-filter-files.md)
+- [FIPS compliance](fips.md)
+- [Frequently asked questions](faq.md)
+- [Functions](functions.md)
+- [Gap locks detection](myrocks-gap-locks-detection.md)
+- [Get help from Percona](get-help.md)
+- [Glossary](glossary.md)
+- [Group replication system variables](group-replication-system-variables.md)
+- [Handle corrupted tables](innodb-corrupt-table-action.md)
+- [How we use artificial intelligence](ai-docs.md)
+- [Improved InnoDB I/O scalability](innodb-io.md)
+- [Improved MEMORY storage engine](improved-memory-engine.md)
+- [Index of INFORMATION_SCHEMA tables](index-info-schema-tables.md)
+- [InnoDB full-text search improvements](innodb-fts-improvements.md)
+- [InnoDB page fragmentation counters](innodb-fragmentation-count.md)
+- [INSERT statement](insert.md)
+- [INSTALL COMPONENT](install-component.md)
+- [Install from Percona Software repository](yum-repo.md)
+- [Install js_lang component](install-js-lang.md)
+- [Install Percona Server for MySQL](installation.md)
+- [Install Percona Server for MySQL and create a database on Oracle Linux](quickstart-yum.md)
+- [Install Percona Server for MySQL and create a database on Ubuntu](quickstart-apt.md)
+- [Install Percona Server for MySQL from a source tarball](source-tarball.md)
+- [Install Percona Server for MySQL Pro](install-pro.md)
+- [Install Percona Server for MySQL using downloaded RPM packages](yum-download-rpm.md)
+- [Install Percona Server for MySQL {{vers}} from a binary tarball](binary-tarball-install.md)
+- [Install Percona Server for MySQL {{vers}} using downloaded DEB packages](apt-download-deb.md)
+- [Install the Audit Log Filter](install-audit-log-filter.md)
+- [Install the data masking component](install-data-masking-component.md)
+- [Introduction to database tables](table.md)
+- [Introduction to Databases and SQL](database.md)
+- [Isolation levels](isolation-levels.md)
+- [Jemalloc memory allocation profiling](jemalloc-profiling.md)
+- [JS privileges](js-lang-privileges.md)
+- [JS stored function or procedure](js-lang-procedures.md)
+- [JS stored procedure and function overview](js-lang-overview.md)
+- [JSON in Percona Server for MySQL](json-overview.md)
+- [Keyring components overview](keyring-components-plugins-overview.md)
+- [Kill idle transaction](kill-idle-trx.md)
+- [LDAP authentication plugin system variables](ldap-system-variables.md)
+- [Limit the estimation of records in a Query](query-limit-records.md)
+- [List of features available in Percona Server for MySQL releases](percona-server-versions-comparison.md)
+- [Log encryption](encrypt-logs.md)
+- [Manage group replication flow control](group-replication-flow-control.md)
+- [Manage SELinux modes](manage-selinux-modes.md)
+- [Manage the Audit Log Filter files](manage-audit-log-filter.md)
+- [Managing AppArmor profiles](manage-apparmor-profiles.md)
+- [Managing binary log disk space](binlog-space.md)
+- [Misc. INFORMATION_SCHEMA tables](misc-info-schema-tables.md)
+- [Modify a table](modify-tables.md)
+- [Multiple page asynchronous I/O requests](aio-page-requests.md)
+- [MyRocks column families](myrocks-column-families.md)
+- [MyRocks Information Schema tables](myrocks-information-schema-tables.md)
+- [MyRocks limitations](myrocks-limitations.md)
+- [MyRocks server variables](myrocks-server-variables.md)
+- [MyRocks status variables](myrocks-status-variables.md)
+- [MySQL Clone plugin](clone-plugin.md)
+- [Next steps](quickstart-next-steps.md)
+- [Overview](quickstart-overview.md)
+- [PAM authentication plugin](pam-plugin.md)
+- [Percona MyRocks installation guide](install-myrocks.md)
+- [Percona MyRocks introduction](myrocks-index.md)
+- [Percona Product Download Instructions](download-instructions.md)
+- [Percona Server for MySQL feature comparison](feature-comparison.md)
+- [Percona Server for MySQL Pro](psmysql-pro.md)
+- [Percona Server for MySQL {{vers}} - Documentation](index.md)
+- [Percona Server for MySQL {{vers}} variables](percona-server-system-variables.md)
+- [Percona Toolkit UDFs](udf-percona-toolkit.md)
+- [The Percona XtraDB storage engine](percona-xtradb.md)
+- [PERCONA_SEQUENCE_TABLE(n) function](percona-sequence-table.md)
+- [Performance Schema MyRocks changes](performance-schema-myrocks-changes.md)
+- [Post-installation](post-installation.md)
+- [Prefix index queries optimization](prefix-index-queries-optimization.md)
+- [Process list](process-list.md)
+- [The ProcFS plugin](procfs-plugin.md)
+- [Quickstart - Run Percona Server for MySQL container images with Docker](quickstart-docker.md)
+- [Reading Audit Log Filter files](reading-audit-log-filter-files.md)
+- [Restrict dynamic log file locations](restrict-dynamic-log-locations.md)
+- [Review effective privileges with SHOW EFFECTIVE GRANTS](extended-show-grants.md)
+- [Rotate the master encryption key](rotate-master-key.md)
+- [Run Percona Server for MySQL](yum-run.md)
+- [Run Percona Server for MySQL {{vers}} after APT repository installation](apt-run.md)
+- [Running Percona Server for MySQL in a Docker Container](docker.md)
+- [Secure Percona Server for MySQL with AppArmor](apparmor.md)
+- [Secure Percona Server for MySQL with SELinux](selinux.md)
+- [SELECT statement](select.md)
+- [SELinux contexts and labels](selinux-contexts.md)
+- [SEQUENCE_TABLE(n) function](sequence-table.md)
+- [Show storage engines](show-engines.md)
+- [Slow query log](slow-extended.md)
+- [Slow query log rotation and expiration](slowlog-rotation.md)
+- [SQL basics](sql-basics.md)
+- [SQL conventions](sql-conventions.md)
+- [SQL operators](sql-operators.md)
+- [SQL syntax](sql-syntax.md)
+- [SSL improvements](ssl-improvement.md)
+- [Stack trace](stacktrace.md)
+- [Start transaction with consistent snapshot](start-transaction-with-consistent-snapshot.md)
+- [Stored Procedures](stored-procedures.md)
+- [Support for PROXY protocol](proxy-protocol-support.md)
+- [Suppress warning messages](log-warnings-suppress.md)
+- [Telemetry on Percona Server for MySQL](telemetry.md)
+- [Thread based profiling](thread-based-profiling.md)
+- [Thread pool](threadpool.md)
+- [Too many connections warning](log-connection-error.md)
+- [Trademark policy](trademark-policy.md)
+- [Transaction management](transaction-mgmt.md)
+- [Trigger updates](trigger-updates.md)
+- [Triggers](triggers.md)
+- [Troubleshoot AppArmor profiles](troubleshoot-apparmor.md)
+- [Troubleshoot JS procedures and functions](js-lang-troubleshoot.md)
+- [Troubleshoot SELinux issues](troubleshoot-selinux.md)
+- [Troubleshoot SQL code](troubleshooting-sql.md)
+- [Understand version numbers](server-version-numbers.md)
+- [Uninstall Audit Log Filter](uninstall-audit-log-filter.md)
+- [UNINSTALL COMPONENT](uninstall-component.md)
+- [Uninstall Percona Server for MySQL](yum-uninstall.md)
+- [Uninstall Percona Server for MySQL {{vers}} using the APT package manager](apt-uninstall-server.md)
+- [Uninstall the component](uninstall-data-masking-component.md)
+- [Uninstall the js_lang component](uninstall-js-lang.md)
+- [UPDATE statement](update.md)
+- [Updated supported features](myrocks-added-features.md)
+- [Upgrade from 8.0 to {{vers}} overview](upgrade.md)
+- [Upgrade strategies](upgrade-strategies.md)
+- [Upgrade to Percona Server for MySQL Pro](upgrade-pro.md)
+- [Upgrade using standalone packages](upgrade-standalone-packages.md)
+- [Upgrade using the Percona repositories](upgrade-percona-repos.md)
+- [Upgrading from plugins to components](upgrade-components.md)
+- [Use an APT repository to install Percona Server for MySQL {{vers}}](apt-repo.md)
+- [Use Docker Compose and named volumes](docker-compose.md)
+- [Use Percona Monitoring and Management (PMM) Advisors](advisors.md)
+- [Use the Amazon Key Management Service (AWS KMS)](using-amz-kms.md)
+- [Use the Key Management Interoperability Protocol (KMIP)](using-kmip.md)
+- [Use the keyring file component](use-keyring-file.md)
+- [Use the keyring vault component](use-keyring-vault-component.md)
+- [User statistics](user-stats.md)
+- [Using LDAP authentication plugins](ldap-authentication.md)
+- [Using libcoredumper](libcoredumper.md)
+- [Utility user](utility-user.md)
+- [UUID_VX component](uuid-versions.md)
+- [Variables in stored procedures, functions, and triggers](stored-procedure-variables.md)
+- [Verify the encryption for tables, tablespaces, and schemas](verify-encryption.md)
+- [Views](views.md)
+- [Write audit_log_filter definitons](write-filter-definitions.md)
+- [XtraDB performance improvements for I/O-bound highly-concurrent workloads](xtradb-performance-improvements.md)

mkdocs-base.yml

@@ -426,5 +426,5 @@ nav:
     - copyright-and-licensing-information.md
     - glossary.md
     - ai-docs.md
-
+  - Topic Index: index-contents.md
 # - Version Selector: "../"

scripts/generate_index.py

@@ -0,0 +1,73 @@
+#!/usr/bin/env python3
+
+"""
+generate_index.py - Generate an index of Markdown files in the top-level docs/ directory.
+
+How to run:
+
+    cd scripts
+    python3 generate_index.py
+
+Run from the root directory of your project.
+"""
+
+import os
+
+def strip_prefixes(s):
+    prefixes = ('The ', 'Work with ')
+    s_lower = s.lower()
+    for prefix in prefixes:
+        if s_lower.startswith(prefix.lower()):
+            return s[len(prefix):]
+    return s
+
+# Define path to docs/ and the output file
+script_dir = os.path.dirname(os.path.abspath(__file__))
+docs_dir = os.path.abspath(os.path.join(script_dir, '..', 'docs'))
+index_file_path = os.path.join(docs_dir, 'index-contents.md')
+
+# Files to exclude
+exclude_files = {'404.md', 'index-contents.md'}
+
+# Delete old index file
+if os.path.exists(index_file_path):
+    os.remove(index_file_path)
+    print(f"Deleted existing index file: {index_file_path}")
+
+index_content = '# Index\n\n'
+
+# Only list .md files in the top-level docs directory
+file_entries = []
+
+for file in os.listdir(docs_dir):
+    if file.endswith('.md') and file not in exclude_files:
+        filepath = os.path.join(docs_dir, file)
+        relative_path = os.path.relpath(filepath, docs_dir).replace(os.sep, '/')
+
+        display_name = ''
+        try:
+            with open(filepath, 'r', encoding='utf-8') as md_file:
+                for line in md_file:
+                    if line.strip().startswith('# '):
+                        display_name = line.strip()[2:].strip()
+                        break
+        except Exception as e:
+            print(f"Error reading file {filepath}: {e}")
+            continue
+
+        if not display_name:
+            display_name = os.path.splitext(file)[0]
+
+        sort_key = strip_prefixes(display_name).strip().lower()
+        file_entries.append((sort_key, display_name, relative_path))
+
+file_entries.sort()
+
+for _, display_name, relative_path in file_entries:
+    index_content += f'- [{display_name}]({relative_path})\n'
+
+# Write the new index
+with open(index_file_path, 'w', encoding='utf-8') as index_file:
+    index_file.write(index_content)
+
+print(f"Index generated at {index_file_path}")