diff --git a/_resourcepdf/overrides/404.html b/_resourcepdf/overrides/404.html new file mode 100644 index 00000000000..36c0dcfc5f0 --- /dev/null +++ b/_resourcepdf/overrides/404.html @@ -0,0 +1,9 @@ +{#- + This file was automatically generated - do not edit + -#} + {% extends "main.html" %} + {% block content %} +

404 - Not found

+

+ We can't find the page you are looking for. Try using the Search or return to homepage .

+ {% endblock %} \ No newline at end of file diff --git a/_resourcepdf/overrides/main.html b/_resourcepdf/overrides/main.html new file mode 100644 index 00000000000..557323bc2b4 --- /dev/null +++ b/_resourcepdf/overrides/main.html @@ -0,0 +1,70 @@ +{# + MkDocs template for builds with Material theme to customize docs layout + by adding marketing-requested elements + #} + + {# Import the theme's layout. #} + {% extends "base.html" %} + + + {% block site_nav %} + {% if nav %} + {% if page.meta and page.meta.hide %} + {% set hidden = "hidden" if "navigation" in page.meta.hide %} + {% endif %} + + {% endif %} + {% if "toc.integrate" not in features %} + {% if page.meta and page.meta.hide %} + {% set hidden = "hidden" if "toc" in page.meta.hide %} + {% endif %} + + {% endif %} + {% endblock %} + + {% block content%} + + {{ super() }} + + + + {% endblock %} + diff --git a/_resourcepdf/overrides/partials/banner.html b/_resourcepdf/overrides/partials/banner.html new file mode 100644 index 00000000000..1ba6c9cef06 --- /dev/null +++ b/_resourcepdf/overrides/partials/banner.html @@ -0,0 +1,9 @@ +
+

+

For help, click the link below to get free database assistance or contact our experts for personalized support.

+ +
+ + Get help from Percona +
+
\ No newline at end of file diff --git a/_resourcepdf/overrides/partials/copyright.html b/_resourcepdf/overrides/partials/copyright.html new file mode 100644 index 00000000000..d31be105f45 --- /dev/null +++ b/_resourcepdf/overrides/partials/copyright.html @@ -0,0 +1,14 @@ +{#- + This file was automatically generated - do not edit + -#} +
+
+ Percona LLC and/or its affiliates, © {{ build_date_utc.strftime('%Y') }} — Cookie Preferences +
+ {% if not config.extra.generator == false %} + Made with + + Material for MkDocs + + {% endif %} +
\ No newline at end of file diff --git a/_resourcepdf/overrides/partials/header.html b/_resourcepdf/overrides/partials/header.html new file mode 100644 index 00000000000..c3d0ed4458b --- /dev/null +++ b/_resourcepdf/overrides/partials/header.html @@ -0,0 +1,135 @@ + + + +{% set class = "md-header" %} +{% if "navigation.tabs.sticky" in features %} + {% set class = class ~ " md-header--shadow md-header--lifted" %} +{% elif "navigation.tabs" not in features %} + {% set class = class ~ " md-header--shadow" %} +{% endif %} + + +
+ + +
+
+ + + + + + + + + + Percona Software for PostgreSQL Documentation + +
+
+ + + + + {% if "navigation.tabs.sticky" in features %} + {% if "navigation.tabs" in features %} + {% include "partials/tabs.html" %} + {% endif %} + {% endif %} +
\ No newline at end of file diff --git a/docs/templates/pdf_cover_page.tpl b/docs/templates/pdf_cover_page.tpl new file mode 100644 index 00000000000..d7a0d919d88 --- /dev/null +++ b/docs/templates/pdf_cover_page.tpl @@ -0,0 +1,11 @@ + +{{ config.extra.added_key }} +

+ +

+

Percona Server for MySQL

+{% if config.site_description %} +

{{ config.site_description }}

+{% endif %} +

8.4 (February 27, 2025)

+ \ No newline at end of file diff --git a/docs/upgrade-components.md b/docs/upgrade-components.md index 7cf99aaa932..d0727ea2b85 100644 --- a/docs/upgrade-components.md +++ b/docs/upgrade-components.md @@ -2,30 +2,6 @@ The following plugins have changed: - - - | Plugin | 8.0 information | {{vers}} changes | Notes | |---|---|---|---| | `keyring_vault` | Only available as a plugin | `component_keyring_vault` | A manual upgrade path is required. For example, the plugin configuration file, specified by the `keyring_vault_config` system variable, must be transformed to a JSON format for the `component_keyring_vault.cnf`. | diff --git a/mkdocs-base.yml b/mkdocs-base.yml index f555c3402bf..d1255844a0e 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -119,23 +119,29 @@ plugins: macros: include_yaml: - 'variables.yml' # Use in markdown as '{{ VAR }}' -# exclude: # Don't process these files -# glob: -# - file.md - with-pdf: # https://github.com/orzih/mkdocs-with-pdf - output_path: '_pdf/PerconaServer-8.4.pdf' - cover_title: 'Percona Server Documentation' - cover_subtitle: 8.4.3-3 (2024-12-18) - author: 'Percona Technical Documentation Team' - cover_logo: docs/_static/pdf-logo.png - debug_html: false - custom_template_path: _resource/templates - enabled_if_env: ENABLE_PDF_EXPORT mike: version_selector: true css_dir: css javascript_dir: js canonical_version: null + print-site: + add_to_navigation: false + print_page_title: 'Percona Server for MySQL documentation' + add_print_site_banner: false + # Table of contents + add_table_of_contents: true + toc_title: 'Table of Contents' + toc_depth: 2 + # Content-related + add_full_urls: false + enumerate_headings: false + enumerate_headings_depth: 1 + enumerate_figures: true + add_cover_page: true + cover_page_template: "docs/templates/pdf_cover_page.tpl" + path_to_pdf: "" + include_css: true + enabled: true extra: version: @@ -143,6 +149,23 @@ extra: default: latest edit_page_text: ' Edit this page' updated_text: ' Page updated' +#Google Analytics configuration + analytics: + provider: google + property: G-J4J70BNH0G + feedback: + title: Was this page helpful? + ratings: + - icon: material/emoticon-happy-outline + name: This page was helpful + data: 1 + note: >- + Thank you for your feedback! + - icon: material/emoticon-sad-outline + name: This page could be improved + data: 0 + note: >- + Thank you for your feedback! Help us improve by following this feedback form. nav: - Home: index.md diff --git a/mkdocs-pdf.yml b/mkdocs-pdf.yml deleted file mode 100644 index 2fe89afb6ad..00000000000 --- a/mkdocs-pdf.yml +++ /dev/null @@ -1,9 +0,0 @@ -# MkDocs configuration for PDF builds -# Usage: ENABLE_PDF_EXPORT=1 mkdocs build -f mkdocs-pdf.yml - -INHERIT: mkdocs-base.yml - -markdown_extensions: - pymdownx.tabbed: {} - admonition: {} - diff --git a/mkdocs.yml b/mkdocs.yml index 941b3c556b8..9756b923349 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,29 +1,258 @@ -# MkDocs configuration for builds with material theme +# MkDocs configuration for PDF builds +# Usage: mkdocs build -f mkdocs-pdf.yml INHERIT: mkdocs-base.yml site_url: "https://docs.percona.com/percona-server/" +# Material theme features theme: name: material - custom_dir: _resource/overrides + logo: _images/postgresql-mark.svg + favicon: _images/postgresql-fav.svg + custom_dir: _resourcepdf/overrides/ + font: + text: Roboto + code: Roboto Mono + icon: + edit: material/file-edit-outline + view: material/file-eye-outline - -#Google Analytics configuration -extra: - analytics: - provider: google - property: G-J4J70BNH0G - feedback: - title: Was this page helpful? - ratings: - - icon: material/emoticon-happy-outline - name: This page was helpful - data: 1 - note: >- - Thank you for your feedback! - - icon: material/emoticon-sad-outline - name: This page could be improved - data: 0 - note: >- - Thank you for your feedback! Help us improve by following this feedback form. +nav: + - Home: index.md + - psmysql-pro.md + - get-help.md + - Release notes: + - Release notes index: release-notes/release-notes-index.md + - release-notes/8.4.3-3.md + - release-notes/8.4.2-2.md + - release-notes/8.4.1.md + - release-notes/8.4.0-1.md + - Features: + - adaptive-network-buffers.md + - Audit Log Filter: + - audit-log-filter-overview.md + - install-audit-log-filter.md + - Formats: + - Overview: audit-log-filter-formats.md + - XML (New style): audit-log-filter-new.md + - XML (Old style): audit-log-filter-old.md + - JSON: audit-log-filter-json.md + - write-filter-definitions.md + - audit-log-filter-security.md + - audit-log-filter-compression-encryption.md + - reading-audit-log-filter-files.md + - manage-audit-log-filter.md + - filter-audit-log-filter-files.md + - audit-log-filter-restrictions.md + - audit-log-filter-naming.md + - disable-audit-log-filter.md + - audit-log-filter-variables.md + - uninstall-audit-log-filter.md + - binlog-space.md + - extended-select-into-outfile.md + - fips.md + - innodb-expanded-fast-index-creation.md + - kill-idle-trx.md + - percona-sequence-table.md + - procfs-plugin.md + - proxy-protocol-support.md + - sequence-table.md + - slowlog-rotation.md + - threadpool.md + - trigger-updates.md + - udf-percona-toolkit.md + - utility-user.md + - Quickstart: + - Quickstart - Overview: quickstart-overview.md + - Quickstart - Run and create database (containers): quickstart-docker.md + - Quickstart - Install and create database (Ubuntu): quickstart-apt.md + - Quickstart - Install and create database (Oracle Linux): quickstart-yum.md + - Quickstart - Next steps: quickstart-next-steps.md + - Install: + - Install Percona Server for MySQL from repositories: installation.md + - Before you start: + - download-instructions.md + - Use APT: + - Use APT repositories: apt-repo.md + - Files in DEB package: apt-files.md + - build-apt-packages.md + - Downloaded DEB packages: apt-download-deb.md + - Apt pinning: apt-pinning.md + - Run Percona Server for MySQL: apt-run.md + - Uninstall: apt-uninstall-server.md + - Use YUM: + - Use RPM repositories: yum-repo.md + - Files in RPM package: yum-files.md + - Downloaded RPM packages: yum-download-rpm.md + - Run Percona Server for MySQL: yum-run.md + - Uninstall: yum-uninstall.md + - Use binary tarballs: + - Install with binary tarballs: binary-tarball-install.md + - Binary tarballs available: binary-tarball-names.md + - Compile from source: + - source-tarball.md + - compile-percona-server.md + - Docker: + - Install using Docker: docker.md + - docker-config.md + - Install Percona Server for MySQL Pro: + - install-pro.md + - pro-files.md + - Upgrade: + - upgrade.md + - upgrade-strategies.md + - upgrade-components.md + - upgrade-percona-repos.md + - upgrade-standalone-packages.md + - upgrade-pro.md + - downgrade.md + - downgrade-from-pro.md + - Post-Installation: + - binlogging-replication-improvements.md + - post-installation.md + - AppArmor: + - apparmor.md + - apparmor-profiles.md + - manage-apparmor-profiles.md + - disable-apparmor.md + - configure-apparmor.md + - troubleshoot-apparmor.md + - SELinux: + - selinux.md + - selinux-contexts.md + - manage-selinux-modes.md + - additional-selinux-tools.md + - troubleshoot-selinux.md + - Develop: + - Fundamental SQL operations: + - sql-basics.md + - common-sql.md + - select.md + - insert.md + - update.md + - delete.md + - sql-operators.md + - Advanced SQL features: + - data-types-basic.md + - functions.md + - sql-conventions.md + - sql-errors.md + - sql-syntax.md + - stored-procedures.md + - stored-procedure-error-handling.md + - stored-procedure-variables.md + - triggers.md + - troubleshooting-sql.md + - JSON: + - json-overview.md + - Manage: + - Database management: + - database.md + - table.md + - create-table.md + - modify-tables.md + - isolation-levels.md + - transaction-mgmt.md + - views.md + - authentication-methods.md + - extended-show-grants.md + - restrict-dynamic-log-locations.md + - clone-plugin.md + - Manage components: + - install-component.md + - uninstall-component.md + - Back up and restore: + - backup-restore-overview.md + - backup-locks.md + - extended-mysqldump.md + - start-transaction-with-consistent-snapshot.md + - Secure: + - LDAP features: + - ldap-authentication.md + - ldap-system-variables.md + - Data masking: + - data-masking-overview.md + - install-data-masking-component.md + - data-masking-function-list.md + - uninstall-data-masking-component.md + - pam-plugin.md + - ssl-improvement.md + - fido-authentication-plugin.md + - encryption-functions.md + - UUID_VX component: + - uuid-versions.md + + - Data-at-rest-encryption: + - data-at-rest-encryption.md + - Keyring components: + - keyring-components-plugins-overview.md + - use-keyring-file.md + - use-keyring-vault-component.md + - using-kmip.md + - using-amz-kms.md + - encrypt-file-per-table-tablespace.md + - encrypt-tablespaces.md + - encrypt-system-tablespace.md + - encrypt-doublewrite-file-pages.md + - encrypt-temporary-files.md + - encrypt-logs.md + - rotate-master-key.md + - verify-encryption.md + - Replicate: + - group-replication-flow-control.md + - group-replication-system-variables.md + - Replication Security: + - encrypt-binary-relay-log-files.md + - Monitor: + - jemalloc-profiling.md + - user-stats.md + - slow-extended.md + - process-list.md + - misc-info-schema-tables.md + - Troubleshoot: + - advisors.md + - log-connection-error.md + - innodb-corrupt-table-action.md + - thread-based-profiling.md + - stacktrace.md + - libcoredumper.md + - Storage engines: + - Percona XtraDB storage engine: + - percona-xtradb.md + - improved-memory-engine.md + - innodb-io.md + - enforce-engine.md + - innodb-show-status.md + - show-engines.md + - compressed-columns.md + - innodb-fts-improvements.md + - xtradb-performance-improvements.md + - aio-page-requests.md + - prefix-index-queries-optimization.md + - query-limit-records.md + - innodb-fragmentation-count.md + - Percona MyRocks: + - myrocks-index.md + - install-myrocks.md + - myrocks-added-features.md + - myrocks-limitations.md + - myrocks-differences.md + - myrocks-information-schema-tables.md + - myrocks-server-variables.md + - myrocks-status-variables.md + - myrocks-gap-locks-detection.md + - myrocks-data-loading.md + - Reference: + - percona-server-system-variables.md + - percona-server-versions-comparison.md + - feature-comparison.md + - server-version-numbers.md + - development.md + - telemetry.md + - trademark-policy.md + - index-info-schema-tables.md + - faq.md + - copyright-and-licensing-information.md + - glossary.md + - ai-docs.md diff --git a/requirements.txt b/requirements.txt index 8bca0f36e7e..df093347242 100644 --- a/requirements.txt +++ b/requirements.txt @@ -13,4 +13,6 @@ mkdocs-htmlproofer-plugin mkdocs-meta-descriptions-plugin mike pillow>=10.0.1 # not directly required, pinned by Snyk to avoid a vulnerability +mkdocs-open-in-new-tab +mkdocs-print-site-plugin