-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
210 lines (210 loc) · 9.43 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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
site_name: Quix Docs
site_description: Quix CLI Documentation
docs_dir: docs/
repo_name: quixio/quix-cli
repo_url: https://github.com/quixio/quix-cli
edit_uri: tree/main/docs
exclude_docs: '*.gen.md'
theme:
name: material
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue grey
accent: blue
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
accent: light blue
toggle:
icon: material/weather-sunny
name: Switch to light mode
features:
- navigation.path
- navigation.indexes
- content.tabs.link
markdown_extensions:
- attr_list
- md_in_html
- admonition
- footnotes
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji ''
emoji_generator: !!python/name:material.extensions.emoji.to_svg ''
- pymdownx.details:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format ''
- pymdownx.tabbed:
alternate_style: true
plugins:
- include-markdown
nav:
- 'Overview': 'overview.md'
- 'Quickstart': 'cli-quickstart.md'
- 'Local Development':
- 'Running applications locally': 'local-development/local-debug.md'
- 'Managing secrets locally': 'local-development/local-secrets.md'
- 'Managing YAML variables': 'local-development/local-yaml-variables.md'
- 'Commands Summary': 'cli-commands-summary.md'
- 'How-To guides':
- 'Using the CLI with GitHub Actions': 'How-To/cli-github-actions.md'
- Yaml Reference:
- 'Pipeline YAML (quix.yaml)': 'yaml-reference/pipeline-descriptor.md'
- 'Application YAML (app.yaml)': 'yaml-reference/app-descriptor.md'
- CLI Reference:
- Cloud Commands:
- cli-reference/cloud/index.md
- cloud apps:
- cli-reference/cloud/apps/index.md
- cloud apps get: cli-reference/cloud/apps/get.md
- cloud apps list: cli-reference/cloud/apps/list.md
- cloud apps library:
- cli-reference/cloud/apps/library/index.md
- cloud apps library list: cli-reference/cloud/apps/library/list.md
- cloud deployments:
- cli-reference/cloud/deployments/index.md
- cloud deployments get: cli-reference/cloud/deployments/get.md
- cloud deployments list: cli-reference/cloud/deployments/list.md
- cloud deployments logs: cli-reference/cloud/deployments/logs.md
- cloud deployments metrics: cli-reference/cloud/deployments/metrics.md
- cloud deployments start: cli-reference/cloud/deployments/start.md
- cloud deployments stop: cli-reference/cloud/deployments/stop.md
- cloud environments:
- cli-reference/cloud/environments/index.md
- cloud environments get: cli-reference/cloud/environments/get.md
- cloud environments list: cli-reference/cloud/environments/list.md
- cloud environments use: cli-reference/cloud/environments/use.md
- cloud environments sync: cli-reference/cloud/environments/sync.md
- cloud environments tokens:
- cli-reference/cloud/environments/tokens/index.md
- cloud environments tokens get: cli-reference/cloud/environments/tokens/get.md
- cloud environments tokens rotate: cli-reference/cloud/environments/tokens/rotate.md
- cloud organisations:
- cli-reference/cloud/organisations/index.md
- cloud organisations get: cli-reference/cloud/organisations/get.md
- cloud projects:
- cli-reference/cloud/projects/index.md
- cloud projects patch: cli-reference/cloud/projects/patch.md
- cloud projects get: cli-reference/cloud/projects/get.md
- cloud projects list: cli-reference/cloud/projects/list.md
- cloud topics:
- cli-reference/cloud/topics/index.md
- cloud topics get: cli-reference/cloud/topics/get.md
- cloud topics list: cli-reference/cloud/topics/list.md
- cloud users:
- cli-reference/cloud/users/index.md
- cloud users audit: cli-reference/cloud/users/audit.md
- cloud users permissions:
- cli-reference/cloud/users/permissions/index.md
- cloud users permissions copy: cli-reference/cloud/users/permissions/copy.md
- cloud users permissions delete: cli-reference/cloud/users/permissions/delete.md
- cloud users permissions edit: cli-reference/cloud/users/permissions/edit.md
- cloud users permissions get: cli-reference/cloud/users/permissions/get.md
- cloud users permissions list: cli-reference/cloud/users/permissions/list.md
- cloud users permissions set: cli-reference/cloud/users/permissions/set.md
- cloud users tokens:
- cli-reference/cloud/users/tokens/index.md
- cloud users tokens create: cli-reference/cloud/users/tokens/create.md
- cloud users tokens edit: cli-reference/cloud/users/tokens/edit.md
- cloud users tokens list: cli-reference/cloud/users/tokens/list.md
- cloud users tokens revoke: cli-reference/cloud/users/tokens/revoke.md
- cloud users current: cli-reference/cloud/users/current.md
- cloud users list: cli-reference/cloud/users/list.md
- Local Commands:
- apps:
- cli-reference/apps/index.md
- apps library: cli-reference/apps/library.md
- apps update: cli-reference/apps/update.md
- apps convert: cli-reference/apps/convert.md
- apps create: cli-reference/apps/create.md
- apps delete: cli-reference/apps/delete.md
- apps edit: cli-reference/apps/edit.md
- apps list: cli-reference/apps/list.md
- apps variables:
- cli-reference/apps/variables/index.md
- apps variables create: cli-reference/apps/variables/create.md
- apps variables delete: cli-reference/apps/variables/delete.md
- apps variables edit: cli-reference/apps/variables/edit.md
- apps variables export: cli-reference/apps/variables/export.md
- apps variables import: cli-reference/apps/variables/import.md
- apps variables list: cli-reference/apps/variables/list.md
- broker:
- cli-reference/broker/index.md
- broker down: cli-reference/broker/down.md
- broker up: cli-reference/broker/up.md
- broker topics:
- cli-reference/broker/topics/index.md
- broker topics list: cli-reference/broker/topics/list.md
- broker topics read: cli-reference/broker/topics/read.md
- broker topics update: cli-reference/broker/topics/update.md
- broker topics write: cli-reference/broker/topics/write.md
- init: cli-reference/init.md
- pipeline:
- cli-reference/pipeline/index.md
- pipeline deployments:
- cli-reference/pipeline/deployments/index.md
- pipeline deployments create: cli-reference/pipeline/deployments/create.md
- pipeline deployments delete: cli-reference/pipeline/deployments/delete.md
- pipeline deployments edit: cli-reference/pipeline/deployments/edit.md
- pipeline deployments get: cli-reference/pipeline/deployments/get.md
- pipeline deployments list: cli-reference/pipeline/deployments/list.md
- pipeline down: cli-reference/pipeline/down.md
- pipeline logs: cli-reference/pipeline/logs.md
- pipeline start: cli-reference/pipeline/start.md
- pipeline status: cli-reference/pipeline/status.md
- pipeline stop: cli-reference/pipeline/stop.md
- pipeline sync: cli-reference/pipeline/sync.md
- pipeline up: cli-reference/pipeline/up.md
- pipeline update: cli-reference/pipeline/update.md
- pipeline view: cli-reference/pipeline/view.md
- pipeline topics:
- cli-reference/pipeline/topics/index.md
- pipeline topics create: cli-reference/pipeline/topics/create.md
- pipeline topics delete: cli-reference/pipeline/topics/delete.md
- pipeline topics edit: cli-reference/pipeline/topics/edit.md
- pipeline topics get: cli-reference/pipeline/topics/get.md
- pipeline topics list: cli-reference/pipeline/topics/list.md
- run: cli-reference/run.md
- sdk:
- cli-reference/sdk/index.md
- sdk broker:
- cli-reference/sdk/broker/index.md
- sdk broker cloud: cli-reference/sdk/broker/cloud.md
- sdk broker current: cli-reference/sdk/broker/current.md
- sdk broker local: cli-reference/sdk/broker/local.md
- sdk broker pipeline: cli-reference/sdk/broker/pipeline.md
- sdk broker set: cli-reference/sdk/broker/set.md
- sdk broker update: cli-reference/sdk/broker/update.md
- Other Commands:
- logout: cli-reference/logout.md
- login: cli-reference/login.md
- contexts:
- cli-reference/contexts/index.md
- contexts create: cli-reference/contexts/create.md
- contexts current: cli-reference/contexts/current.md
- contexts list: cli-reference/contexts/list.md
- contexts delete: cli-reference/contexts/delete.md
- contexts reset: cli-reference/contexts/reset.md
- contexts use: cli-reference/contexts/use.md
- contexts environments:
- cli-reference/contexts/environments/index.md
- contexts environments clear: cli-reference/contexts/environments/clear.md
- contexts environments get: cli-reference/contexts/environments/get.md
- contexts environments use: cli-reference/contexts/environments/use.md
- status: cli-reference/status.md
- update: cli-reference/update.md
- use: cli-reference/use.md
...