attune/mkdocs.yml at main · attune-io/attune · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
site_name: Attune
site_description: Safe, in-place Kubernetes pod resource right-sizing
site_url: https://attune-io.github.io/attune/
repo_url: https://github.com/attune-io/attune
repo_name: attune-io/attune
docs_dir: docs

theme:
  name: material
  palette:
    - scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy
    - search.highlight

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Why Attune?: why-attune.md
  - Specification: SPEC.md
  - Savings Calculator: savings-calculator.md
  - Getting Started:
      - Core Concepts: getting-started/concepts.md
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Your First 30 Days: getting-started/first-30-days.md
  - Guides:
      - Recommend Mode: guides/recommend-mode.md
      - Canary Rollout: guides/canary-rollout.md
      - Auto Mode: guides/auto-mode.md
      - Startup Boost: guides/startup-boost.md
      - HPA Coexistence: guides/hpa-coexistence.md
      - Prometheus Setup: guides/prometheus-setup.md
      - Istio Integration: guides/istio-integration.md
      - GitOps Integration: guides/gitops-integration.md
      - Migrating from VPA: guides/migrating-from-vpa.md
      - FIPS 140-3 Compliance: guides/fips-compliance.md
      - Scaling: guides/scaling.md
      - Troubleshooting: guides/troubleshooting.md
      - Upgrading: guides/upgrading.md
  - Reference:
      - API Reference: reference/api.md
      - CLI Reference: reference/cli.md
      - Configuration: reference/configuration.md
      - Metrics: reference/metrics.md
  - Architecture:
      - Design: architecture/design.md
      - Algorithm: architecture/algorithm.md
      - Resize API: architecture/resize-api.md
      - Safety: architecture/safety.md
  - Community:
      - CNCF Landscape: community/cncf-landscape.md
  - Contributing:
      - Development: contributing/development.md
      - Testing: contributing/testing.md
      - Releasing: contributing/releasing.md
      - Adding Workload Types: contributing/adding-workload-types.md