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
hooks:
- hack/mkdocs-copy-geps.py
watch:
- geps
theme:
  name: material
  icon:
    repo: fontawesome/brands/git-alt
  logo: images/k8s-favicon.png
  favicon: images/k8s-favicon.png
  features:
    - search.highlight
    - navigation.tabs
    - navigation.top
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'
        'contributing/community.md': 'contributing/index.md'
        'contributing/gamma.md': 'concepts/gamma.md#contributing'
        'references/implementers-guide.md': 'reference/implementers-guide.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
        GAMMA: concepts/gamma.md
        Conformance: concepts/conformance.md
        Implementation Guidelines: concepts/guidelines.md
        Roles and Personas: concepts/roles-and-personas.md
        Service Facets: concepts/service-facets.md
        Security Model: concepts/security-model.md
        Use Cases: concepts/use-cases.md
        Versioning: concepts/versioning.md
    - Implementations: implementations.md
    - FAQ: faq.md
    - Glossary: concepts/glossary.md
  - 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
    - 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
  - Reference:
    - Implementer's Guide: reference/implementers-guide.md
    - 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
    - Enhancement Proposals:
      - Overview: geps/overview.md
      - Declined:
        - geps/gep-735.md
        - geps/gep-1282.md
      - Provisional:
        - geps/gep-1619.md
        - geps/gep-1867.md
      # - Implementable:
      #   -
      - Experimental:
        - geps/gep-713.md
        - geps/gep-957.md
        - geps/gep-1016.md
        - geps/gep-1324.md
        - geps/gep-1426.md
        - geps/gep-1651.md
        - geps/gep-1686.md
        - geps/gep-1709.md
        - geps/gep-1742.md
        - geps/gep-1748.md
        - geps/gep-1762.md
        - geps/gep-1897.md
        - geps/gep-1911.md
        - geps/gep-2162.md
        - geps/gep-2257.md
      - Standard:
        - geps/gep-709.md
        - geps/gep-718.md
        - geps/gep-724.md
        - geps/gep-726.md
        - geps/gep-746.md
        - geps/gep-820.md
        - geps/gep-851.md
        - geps/gep-917.md
        - geps/gep-922.md
        - geps/gep-1323.md
        - geps/gep-1364.md
      - Glossary: concepts/glossary.md
  - Contributing:
    - How to Get Involved: contributing/index.md
    - Developer Guide: contributing/devguide.md
    - Enhancement Requests: contributing/enhancement-requests.md
    - Contributor Ladder: contributing/contributor-ladder.md
  - Blog:
    - Index: blog/index.md
    - 2023:
      - blog/2023/0829-mesh-support.md
    - 2022:
      - blog/2022/graduating-to-beta.md
    - 2021:
      - blog/2021/introducing-v1alpha2.md