mkdocs.yml

# Configuration settings in this file should be ordered
# alphabetically.
---
# yamllint disable rule:line-length
copyright: >
  <a href="https://creativecommons.org/licenses/by-sa/4.0/">
  <img src="https://mirrors.creativecommons.org/presskit/buttons/80x15/svg/by-sa.svg"/>
  </a>
edit_uri: ./edit/main/docs
extra:
  academy: "Cleura Cloud Academy"
  academy_domain: "academy.cleura.cloud"
  analytics:
    domain: docs.cleura.cloud
    provider: plausible
  brand: "Cleura Cloud"
  brand_compliant: "Cleura Compliant Cloud"
  brand_container_orchestration: "Gardener in Cleura Cloud"
  brand_domain: "citycloud.com"
  brand_public: "Cleura Public Cloud"
  company: "Cleura"
  company_domain: "cleura.com"
  gui: "Cleura Cloud Management Panel"
  gui_domain: "cleura.cloud"
  k8s_management_service: Gardener
  legal_docs:
    cc_by_sa:
      name: "Creative Commons Attribution-ShareAlike 4.0 International"
      short_name: "CC BY-SA"
      url: "https://creativecommons.org/licenses/by-sa/4.0/"
    cdpa:
      last_updated: 2024-03-22
      name: "Data Processing Agreement"
      url: "https://s3-kna1.citycloud.com/6a5aa55d8f094a13ae18199639aa72c2:cleura.files/Cleura_Data_Processing_Agreement_for_Public_Cloud-V24.03.25.pdf"
      valid_from: 2024-03-25
    termination_form:
      name: "Termination of Subscription Form"
      url: "https://s3-kna1.citycloud.com/6a5aa55d8f094a13ae18199639aa72c2:cleura.files/Cleura-Form-Termination-Of-Subscription.pdf"
    tos:
      last_updated: 2023-09-08
      name: "Terms of Service"
      url: "https://s3-kna1.citycloud.com/6a5aa55d8f094a13ae18199639aa72c2:cleura.files/Cleura_Terms_of_Service-Public_Cloud_v2023.9.8.pdf"
      valid_from: 2023-10-03
    transfer_form:
      name: "Transfer Form"
      url: "https://s3-kna1.citycloud.com/6a5aa55d8f094a13ae18199639aa72c2:cleura.files/Cleura-Form-Transfer-Ownership.pdf"
  rest_api: "Cleura Cloud REST API"
  rest_api_domain: "rest.cleura.cloud"
  support: "Service Center"
  support_domain: "servicecenter.cleura.cloud"
  support_email: "support@cleura.com"
extra_css:
  - assets/stylesheets/cleura-palette.css
markdown_extensions:
  - attr_list
  - footnotes
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - smarty
  - tables
plugins:
  - awesome-pages
  - exclude-search
  - git-authors:
      enabled: true
      show_email_address: false
  - git-revision-date-localized:
      enable_creation_date: true
      enabled: true
      fallback_to_build_date: false
      locale: en
      timezone: Etc/UTC
      type: iso_date
  - glightbox
  - macros:
      # yamllint disable-line rule:truthy
      on_error_fail: !ENV [DOCS_FAIL_ON_MACRO_ERROR, True]
      on_undefined: strict
  - search
  - social:
      # yamllint disable-line rule:truthy
      cards: !ENV [DOCS_ENABLE_SOCIAL_CARDS, True]
  - redirects:
      redirect_maps:
        'howto/account-billing/change-billing-data.md': 'howto/account-billing/change-account-data.md'
repo_url: https://github.com/citynetwork/docs
site_name: "Cleura Docs"
site_url: !ENV [DOCS_SITE_URL, "https://docs.cleura.cloud"]
theme:
  custom_dir: theme
  favicon: assets/favicon.ico
  features:
    - navigation.indexes
    - content.action.edit
  icon:
    edit: material/file-edit-outline
    repo: fontawesome/brands/github
  logo: assets/logo.png
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/lightbulb-outline
        name: "Switch to dark mode"
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/lightbulb
        name: "Switch to light mode"
validation:
  absolute_links: warn
  omitted_files: warn
  unrecognized_links: warn