forked from iter8-tools/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
185 lines (174 loc) · 5.6 KB
/
mkdocs.yml
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
site_name: Iter8
site_url: https://iter8.tools/latest
site_author: Srinivasan Parthasarathy
site_description: >-
Iter8 is the Kubernetes release optimizer built for DevOps, MLOps, SRE and data science teams. Iter8 makes it easy to ensure that Kubernetes apps and ML models perform well and maximize business value.
# Repository
repo_name: iter8-tools/iter8
repo_url: https://github.com/iter8-tools/iter8
edit_uri: ""
# Configuration
theme:
name: material
custom_dir: overrides
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
# Default values, taken from mkdocs_theme.yml
language: en
features:
- content.code.copy
- navigation.instant
- navigation.sections
- navigation.tabs
- navigation.top
- navigation.indexes
palette:
- scheme: primary
primary: black
accent: deep orange
font:
text: Roboto
code: Roboto Mono
favicon: images/favicon.png
logo: images/logo.svg
# Plugins
plugins:
- search
- tags
- minify:
minify_html: true
- mike
# Customization
extra:
# Google Analytics
analytics:
provider: google
property: UA-152813895-1
title: Kubernetes Release Optimizer
version:
provider: mike
social:
- icon: fontawesome/brands/github
link: https://github.com/iter8-tools/iter8
- icon: fontawesome/brands/slack
link: https://join.slack.com/t/iter8-tools/shared_invite/zt-awl2se8i-L0pZCpuHntpPejxzLicbmw
generator: false
copyright: Iter8 is open-source and available under the Apache 2 License.
# Extensions
markdown_extensions:
- admonition
- abbr
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: iter8-tools
repo: iter8
- pymdownx.smartsymbols
- pymdownx.snippets:
base_path:
- "./"
check_paths: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
# Page tree
nav:
- Home: index.md
- Getting Started:
- Your first progressive release: getting-started/first-release.md
- Your first A/B test: getting-started/first-abn.md
- Your first performance test: getting-started/first-performance.md
- Installation: getting-started/install.md
- Concepts: getting-started/concepts.md
- Advantages: getting-started/advantages.md
- Get help: getting-started/help.md
- Tutorials:
- Progressive release:
- Blue-green: tutorials/blue-green.md
- Canary: tutorials/canary.md
- Mirrored: tutorials/mirror.md
- A/B testing with Iter8 SDK: tutorials/abn.md
- Performace testing:
- Single HTTP endpoint: tutorials/performance/load-test-http.md
- Multiple HTTP endpoints: tutorials/performance/load-test-http-multiple.md
- Single gRPC method: tutorials/performance/load-test-grpc.md
- Multiple gRPC methods: tutorials/performance/load-test-grpc-multiple.md
- Integrations:
- Kubernetes Gateway API:
- Progressive release:
- Blue-green: tutorials/integrations/kubernetes-gateway-api/blue-green.md
- Canary: tutorials/integrations/kubernetes-gateway-api/canary.md
- Kserve:
- Progressive release:
- Blue-green: tutorials/integrations/kserve/blue-green.md
- Canary: tutorials/integrations/kserve/canary.md
- A/B testing:
- Inference request by HTTP: tutorials/integrations/kserve/abn-http.md
- Inference request by gRPC: tutorials/integrations/kserve/abn-grpc.md
- Performance testing:
- Inference request by HTTP: tutorials/integrations/kserve/http.md
- Inference request by gRPC: tutorials/integrations/kserve/grpc.md
- Kserve (modelmesh):
- Progressive release:
- Blue-green: tutorials/integrations/kserve-mm/blue-green.md
- Canary: tutorials/integrations/kserve-mm/canary.md
- A/B testing: tutorials/integrations/kserve-mm/abn.md
- Performance testing: tutorials/integrations/kserve-mm/performance.md
- GitHub Actions: tutorials/integrations/ghactions.md
- Slack: tutorials/integrations/slack.md
- User guide:
- Topics:
- Installation: user-guide/install.md
- Uninstall: user-guide/uninstall.md
- Progressive release:
- About: user-guide/progressive-release/about.md
- Using new resource types: user-guide/progressive-release/extension.md
- A/B/n testing:
- About: user-guide/abn/about.md
- Using the SDK: user-guide/abn/using-sdk.md
- Using new resource types: user-guide/abn/extension.md
- Performance testing:
- Parameters: user-guide/performance/parameters.md
- Test Tasks:
- http: user-guide/performance/tasks/http.md
- grpc: user-guide/performance/tasks/grpc.md
- ready: user-guide/performance/tasks/ready.md
- github: user-guide/performance/tasks/github.md
- slack: user-guide/performance/tasks/slack.md
- Using new resource types: user-guide/performance/extension.md
- Routemaps: user-guide/routemap.md
- Metrics store options: user-guide/metrics_store.md
- Contributing: contributing.md
- Roadmap: roadmap.md
- Community:
- Community: community/community.md
- News: community/news.md