mirror of
https://github.com/hanzo-ml/kuberay.git
synced 2026-10-30 19:48:47 +00:00
90 lines
2.0 KiB
YAML
90 lines
2.0 KiB
YAML
# Project Information
|
|
site_name: KubeRay Docs
|
|
site_url: https://ray-project.github.io/kuberay
|
|
|
|
# Repository
|
|
repo_name: ray-project/kuberay
|
|
repo_url: https://github.com/ray-project/kuberay
|
|
edit_uri: ""
|
|
|
|
# Configuration
|
|
theme:
|
|
name: material
|
|
language: en
|
|
features:
|
|
- navigation.tabs
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
|
|
# Navigation
|
|
nav:
|
|
- Home:
|
|
- Welcome: index.md
|
|
- Installation(Yaml): deploy/installation.md
|
|
- Installation(Helm): deploy/helm.md
|
|
- Installation(Helm-cluster): deploy/helm-cluster.md
|
|
- Components:
|
|
- KubeRay Operator: components/operator.md
|
|
- KubeRay ApiServer: components/apiserver.md
|
|
- KubeRay CLI: components/cli.md
|
|
- Features:
|
|
- RayService: guidance/rayservice.md
|
|
- RayJob: guidance/rayjob.md
|
|
- Ray GCS FT: guidance/gcs-ft.md
|
|
- Autoscaling: guidance/autoscaler.md
|
|
- Ingress: guidance/ingress.md
|
|
- Observability: guidance/observability.md
|
|
- Best Practice:
|
|
- Worker reconnection: best-practice/worker-head-reconnection.md
|
|
- Troubleshooting:
|
|
- Guidance: troubleshooting.md
|
|
- Designs:
|
|
- Core API and Backend Service: design/protobuf-grpc-service.md
|
|
- Development:
|
|
- Development: development/development.md
|
|
- Release: development/release.md
|
|
|
|
# Customization
|
|
extra:
|
|
version:
|
|
provider: mike
|
|
|
|
plugins:
|
|
- tags
|
|
- search
|
|
|
|
# Markdown Extension
|
|
markdown_extensions:
|
|
# Python Markdown
|
|
- abbr
|
|
- admonition
|
|
- attr_list
|
|
- def_list
|
|
- footnotes
|
|
- meta
|
|
- md_in_html
|
|
- toc:
|
|
permalink: true
|
|
|
|
# Python Markdown Extensions
|
|
- pymdownx.arithmatex:
|
|
generic: true
|
|
- pymdownx.betterem:
|
|
smart_enable: all
|
|
- pymdownx.caret
|
|
- pymdownx.details
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
|
- pymdownx.highlight
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.keys
|
|
- pymdownx.mark
|
|
- pymdownx.smartsymbols
|
|
- pymdownx.superfences
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.tilde
|