mkdocs.yml

site_name: PagerDuty plugin for Backstage
site_url: https://pagerduty.github.io/backstage-plugin-docs/
theme:
  name: material
  custom_dir: overrides
  logo: 'assets/pd-logo.png'
  favicon: 'assets/favicon.png'
  font:
    text: 'Open Sans'

  features:
    - content.code.copy
    - content.code.annotate
    - header.autohide
    - announce.dismiss

  palette:
    - media: '(prefers-color-scheme: light)'
      scheme: default
      toggle:
        icon: material/toggle-switch
        name: Swith to dark mode
      primary: custom
      accent: custom

    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      toggle:
        icon: material/toggle-switch-off-outline
        name: Swith to light mode
      primary: custom
      accent: custom

extra_css:
    - stylesheets/extra.css

extra:
  analytics:
    provider: google
    property: G-TQ2EQJ9EFN
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: Thanks for your feedback!
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
  social:
    - icon: fontawesome/solid/globe
      link: https://backstage.spotify.com/marketplace/pagerduty/plugin/pagerduty
    - icon: fontawesome/brands/discord
      link: https://discord.com/servers/backstage-687207715902193673
    - icon: fontawesome/brands/github
      link: https://github.com/PagerDuty/backstage-plugin-docs

nav:
  - Overview: index.md
  - Getting started:
    - PagerDuty integration: getting-started/pagerduty.md
    - Configuring Backstage: getting-started/backstage.md
  - Capabilities: capabilities.md
  - Advanced:
    - Configure REST API url: advanced/configure-api-url.md
    - Configure Events url: advanced/configure-events-url.md
    - Configure service dependency sync: advanced/configure-service-dependency-sync.md
    - Create an homepage component: advanced/homepage-component.md
    - Create PagerDuty service with Software Templates: advanced/create-service-software-template.md
    - Enable read-only mode: advanced/enable-read-only-mode.md
    - Hide change events: advanced/hide-change-events.md
    - Hide on-call: advanced/hide-oncall.md
    - Mapping PagerDuty Services to Backstage Entities: advanced/service-entity-mapping.md
  - UI Components:
    - PagerDutyCard: components/pagerduty-card.md
    - PagerDutySmallCard: components/pagerduty-small-card.md
    - PagerDutyPage: components/pagerduty-page.md
  - Migration: 
    - From Backstage-owned plugin: migration/from-backstage-owned.md
    - To Backstage's new backend system: migration/backend-system-migration.md
  - Community: community.md
  - Release Notes:
    - Frontend plugin: release-notes/frontend.md
    - Backend plugin: release-notes/backend.md
    - Common library: release-notes/common.md
    - Scaffolder Actions module: release-notes/scaffolder-actions.md
    - Entity Processor module: release-notes/entity-processor.md

markdown_extensions:
  - pymdownx.tasklist:
      custom_checkbox: true
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences