mkdocs.yml

site_name: Kubernetes Gateway API
repo_url: https://github.com/kubernetes-sigs/gateway-api
repo_name: kubernetes-sigs/gateway-api
site_dir: site
docs_dir: site-src
trademark: https://www.linuxfoundation.org/legal/trademark-usage
extra_css:
  - stylesheets/extra.css
extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - js/implementations.js
hooks:
- hack/mkdocs-copy-geps.py
- hack/mkdocs-generate-conformance.py
watch:
- geps
theme:
  name: material
  icon:
    repo: fontawesome/brands/git-alt
  logo: images/logo/logo-text-large-horizontal-white.png
  favicon: images/k8s-favicon.png
  features:
    - search.highlight
    - navigation.tabs
    - navigation.top
    - navigation.expand
  palette:
    primary: custom
  custom_dir: site-src/overrides
edit_uri: edit/main/site-src/
plugins:
  - search
  - awesome-pages
  - macros:
      include_dir: examples
      j2_line_comment_prefix: "#$"
  - redirects:
      redirect_maps:
        'guides/getting-started.md': 'guides/index.md'
        'concepts/gamma.md': 'mesh/index.md'
        'concepts/service-facets.md': 'mesh/service-facets.md'
        'concepts/guidelines.md': 'guides/api-design.md'
        'contributing/community.md': 'contributing/index.md'
        'contributing/gamma.md': 'mesh/index.md#contributing'
        'reference/implementers-guide.md': 'guides/implementers.md'
        'references/implementers-guide.md': 'guides/implementers.md'
        'references/spec.md': 'reference/spec.md'
        'references/policy-attachment.md': 'reference/policy-attachment.md'
  - mermaid2
markdown_extensions:
  - admonition
  - meta
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets
  - toc:
      permalink: true
  - tables
nav:
  - Overview:
    - Introduction: index.md
    - Concepts:
        API Overview: concepts/api-overview.md
        Conformance: concepts/conformance.md
        Roles and Personas: concepts/roles-and-personas.md
        Security Model: concepts/security-model.md
        Tools: concepts/tooling.md
        Use Cases: concepts/use-cases.md
        Versioning: concepts/versioning.md
    - Service Mesh:
        Overview: mesh/index.md
        GAMMA Initiative: mesh/gamma.md
        Service Facets: mesh/service-facets.md
    - Implementations:
        - List: implementations.md
        - Comparisons:
          - v1.2: implementations/v1.2.md
          - v1.1: implementations/v1.1.md
          - v1.0: implementations/v1.0.md
    - FAQ: faq.md
    - Glossary: concepts/glossary.md
  - Guides:
    - User Guides:
      - Getting started: guides/index.md
      - Simple Gateway: guides/simple-gateway.md
      - HTTP routing: guides/http-routing.md
      - HTTP redirects and rewrites: guides/http-redirect-rewrite.md
      - HTTP header modifier: guides/http-header-modifier.md
      - HTTP traffic splitting: guides/traffic-splitting.md
      - HTTP request mirroring: guides/http-request-mirroring.md
      - Cross-Namespace routing: guides/multiple-ns.md
      - TLS: guides/tls.md
      - TCP routing: guides/tcp.md
      - gRPC Routing: guides/grpc-routing.md
      - Migrating from Ingress: guides/migrating-from-ingress.md
      - Backend Protocol Selection: guides/backend-protocol.md
      - Infrastructure attributes: guides/infrastructure.md
    - API Design: guides/api-design.md
    - CRD Management: guides/crd-management.md
    - Implementer's Guide: guides/implementers.md
  - Reference:
    - API Types:
      - Gateway: api-types/gateway.md
      - GatewayClass: api-types/gatewayclass.md
      - GRPCRoute: api-types/grpcroute.md
      - HTTPRoute: api-types/httproute.md
      - Policy:
        - BackendTLSPolicy: api-types/backendtlspolicy.md
      - ReferenceGrant: api-types/referencegrant.md
    - API specification: reference/spec.md
    - Policy Attachment: reference/policy-attachment.md
  - Enhancements:
    - Overview: geps/overview.md
    - Provisional:
      - geps/gep-91/index.md
      - geps/gep-1651/index.md
      - geps/gep-1867/index.md
      - geps/gep-2648/index.md
      - geps/gep-2649/index.md
    - Implementable:
      - geps/gep-3155/index.md
    - Experimental:
      - geps/gep-995/index.md
      - geps/gep-1619/index.md
      - geps/gep-1731/index.md
      - geps/gep-1748/index.md
      - geps/gep-1897/index.md
      - geps/gep-2162/index.md
      - geps/gep-3155/index.md
      - geps/gep-3171/index.md
    - Standard:
      - geps/gep-709/index.md
      - geps/gep-718/index.md
      - geps/gep-724/index.md
      - geps/gep-726/index.md
      - geps/gep-746/index.md
      - geps/gep-820/index.md
      - geps/gep-851/index.md
      - geps/gep-957/index.md
      - geps/gep-1016/index.md
      - geps/gep-1294/index.md
      - geps/gep-1323/index.md
      - geps/gep-1364/index.md
      - geps/gep-1686/index.md
      - geps/gep-1709/index.md
      - geps/gep-1742/index.md
      - geps/gep-1762/index.md
      - geps/gep-1911/index.md
      - geps/gep-2257/index.md
    - Memorandum:
      - geps/gep-713/index.md
      - geps/gep-917/index.md
      - geps/gep-922/index.md
      - geps/gep-1324/index.md
      - geps/gep-2659/index.md
      - geps/gep-2722/index.md
      - geps/gep-2907/index.md
    - Declined:
      - geps/gep-735/index.md
      - geps/gep-1282/index.md
  - Contributing:
    - How to Get Involved: contributing/index.md
    - Developer Guide: contributing/devguide.md
    - Documentation Style Guide: contributing/style-guide.md
    - Enhancement Requests: contributing/enhancement-requests.md
    - Release Cycle: contributing/release-cycle.md
    - Contributor Ladder: contributing/contributor-ladder.md