mkdocs-base.yml

# MkDocs configuration
# Used as base - look for .yml files with INHERIT
site_name: Percona Operator for PostgreSQL
site_description: Documentation
site_author: Percona LLC
site_url: ""
copyright: 
  <a href="https://www.percona.com/about">Percona LLC</a> and/or its affiliates © 2024 — <a href="#" onclick="Osano.cm.showDrawer('osano-cm-dom-info-dialog-open')">Cookie Preferences</a>
use_directory_urls: false
repo_name: percona/k8spg-docs
repo_url: https://github.com/percona/k8spg-docs
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/images/operators-mark.svg
  favicon: assets/images/operators-fav.svg
  custom_dir: _resource/overrides/
  font:
    text: Roboto
    code: Roboto Mono
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Color theme set to Automatic. Click to change
    - media: "(prefers-color-scheme: light)"
      scheme: percona-light
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Color theme set to Light Mode. Click to change
    - media: "(prefers-color-scheme: dark)"
      scheme: percona-dark
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Color theme set to Dark Mode. Click to change

extra_css:
  - https://unicons.iconscout.com/release/v3.0.3/css/line.css
  - https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.4.0/css/font-awesome.min.css
  - css/lightgallery.min.css
  - css/nocopy.css
  - css/extra.css
  - css/design.css
  - css/osano.css
  - css/operators.css

extra_javascript:
  - js/promptremover.js
  - js/consent.js
#  - js/version-select.js
  - js/toctree.js
  - js/lightgallery.min.js
  - js/percona-select.js

markdown_extensions:
  attr_list: {}
  toc:
    permalink: True
  admonition: {}
  def_list: {}
  meta: {}
  smarty: { smart_angled_quotes: true }
  pymdownx.details: {}
  pymdownx.mark: {}
  pymdownx.smartsymbols: {}
  pymdownx.tilde: {}
  pymdownx.superfences: {}
  pymdownx.tabbed:
    alternate_style: true
  pymdownx.highlight:
    linenums: false
  pymdownx.emoji:
    emoji_index: !!python/name:materialx.emoji.twemoji
    emoji_generator: !!python/name:materialx.emoji.to_svg

plugins:
  section-index: {}
  search: 
    separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  git-revision-date: {}
  meta-descriptions:
    export_csv: false
    quiet: false
    enable_checks: false
    min_length: 50
    max_length: 160
  macros:
    include_yaml:
      - "variables.yml"
  # https://pypi.org/project/mkdocs-exclude/
  exclude:
    glob:
      - "setting-up/client/docker.md"
  # https://github.com/orzih/mkdocs-with-pdf
  with-pdf:
    output_path: "_pdf/PerconaOperatorPostgreSQL.pdf"
    cover_title: "Percona Operator for PostgreSQL documentation"
    cover_subtitle: 1.6.0 (May 23, 2024)
    author: "Percona Technical Documentation Team"
    cover_logo: docs/assets/images/percona_kubernetes_icon.png
    custom_template_path: _resource/templates
    enabled_if_env: ENABLE_PDF_EXPORT
  # Check links - but extends build time significantly
  # https://pypi.org/project/mkdocs-htmlproofer-plugin/
  #    htmlproofer: {}
  mike:
    version_selector: false
    css_dir: css
    javascript_dir: js
    canonical_version: null

extra: # Used in main.html template and can't be externalized
  edit_page_text: '<i class="uil uil-pen"></i> <b>Edit this page</b>'
  updated_text: '<i class="uil uil-refresh"></i> Page updated'
  release: 1.6.0
  certmanagerversion: '1.12.10'
  pmm2recommended: 2.41.2
  postgresrecommended: 14.11
  version:
    provider: mike

# Common navigation for percona.com, render.com and PDF
nav:

    - Welcome: index.md
    - Requirements:
          - "System Requirements": System-Requirements.md
          - "Design and architecture": architecture.md
          - "Comparison with other solutions": compare.md
          
    - Quickstart guides:
          - "Install on Minikube": minikube.md
          - "Install with Helm": helm.md
          
    - Installation guide:
          - "Install on Google Kubernetes Engine (GKE)": gke.md
          - "Generic Kubernetes installation": kubernetes.md
          - "Install on OpenShift": openshift.md
          
    - Configuration:
          - "Application and system users": users.md
          - "Changing PostgreSQL Options": options.md
          - "Anti-affinity and tolerations": constraints.md
          - "Transport Encryption (TLS/SSL)": TLS.md
          - "Telemetry": telemetry.md
          
    - Management:
          - "Backup and restore": backups.md
          - "Upgrade Percona Distribution for PostgreSQL and the Operator": update.md
          - "Horizontal and vertical scaling": scaling.md
          - "Monitor with Percona Monitoring and Management (PMM)": monitoring.md
          - "Restart or pause the cluster": pause.md
          
    - How to:
          - "Deploy a standby cluster for Disaster Recovery": standby.md
          - "Provide Percona Operator for PostgreSQL single-namespace and multi-namespace deployment": cluster-wide.md
          - "Use PostgreSQL tablespaces with Percona Operator for PostgreSQL": tablespace.md
          - "Creating a private S3-compatible cloud for backups": private.md
          
    - Reference:
          - "Custom Resource options": operator.md
          - "Operator installation options": installation-options.md
          - "Percona certified images": images.md
          - "Frequently Asked Questions": faq.md
          - "Old releases (documentation archive)": https://docs.percona.com/legacy-documentation/
          - "Copyright and licensing information": copyright.md
          - "Trademark policy": trademark-policy.md
          
    - Release Notes:
          - "Release notes index": ReleaseNotes/index.md
          - "Percona Operator for PostgreSQL 1.6.0 (2024-05-23)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN1.6.0.md
          - "Percona Operator for PostgreSQL 1.5.1 (2024-01-29)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN1.5.1.md
          - "Percona Operator for PostgreSQL 1.5.0 (2023-12-11)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN1.5.0.md
          - "Percona Operator for PostgreSQL 1.4.0 (2023-03-31)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN1.4.0.md
          - "Percona Operator for PostgreSQL 1.3.0 (2022-08-04)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN1.3.0.md
          - "Percona Operator for PostgreSQL 1.2.0 (2022-04-06)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN1.2.0.md
          - "Percona Operator for PostgreSQL 1.1.0 (2021-12-07)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN1.1.0.md
          - "Percona Operator for PostgreSQL 1.0.0 (2021-10-07)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN1.0.0.md
          - "Percona Operator for PostgreSQL 0.2.0 (2021-08-12)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN0.2.0.md
          - "Percona Operator for PostgreSQL 0.1.0 (2021-05-10)": ReleaseNotes/Kubernetes-Operator-for-PostgreSQL-RN0.1.0.md
    - Join K8S Squad: https://www.percona.com/k8s