-
Notifications
You must be signed in to change notification settings - Fork 28
/
Copy pathmkdocs.yml
148 lines (142 loc) · 4.58 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
# Project information
site_name: Uffizzi Docs
site_author: Uffizzi.com
site_description: >-
Uffizzi Documentation
site_url: https://docs.uffizzi.com/
# Repository
repo_url: https://github.com/UffizziCloud/docs
repo_name: UffizziCloud/docs
edit_uri: edit/main/docs/
# Copyright
copyright: Copyright © 2023 Uffizzi
# Styling
extra_css:
- stylesheets/extra.css
theme:
name: material
locale: en_US
logo: assets/images/u-logo.svg
favicon: assets/images/favicon.png
features:
- content.code.annotate
- navigation.instant
- navigation.tabs
- navigation.tabs.sticky
- navigation.tracking
- navigation.sections
- navigation.expand
- navigation.indexes
- navigation.top
- footer.autohide
- search.highlight
- search.share
- search.suggest
# Plugins
plugins:
- search
- minify:
minify_html: true
# Customization
extra:
social:
- icon: fontawesome/brands/slack
link: https://join.slack.com/t/uffizzi/shared_invite/zt-ffr4o3x0-J~0yVT6qgFV~wmGm19Ux9A
- icon: fontawesome/brands/twitter
link: https://twitter.com/Uffizzi_
- icon: fontawesome/brands/docker
link: https://hub.docker.com/orgs/uffizzi
- icon: fontawesome/brands/github
link: https://github.com/UffizziCloud
generator: true
analytics:
provider: google
property: UA-157967585-1
homepage: https://www.uffizzi.com
# 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.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: squidfunk
repo: mkdocs-material
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid-experimental
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
# Page tree
nav:
- Home:
- Home: index.md
- Quickstart Guide: quickstart.md
- Installation: install.md
- Using Uffizzi: using-uffizzi.md
- Virtual Cluster Environments from CI Pipelines: virtual-cluster-environment.md
- Docker Compose Environments from CI Pipelines: docker-compose-environment.md
- Architecture: architecture.md
- How-To:
- Uffizzi CI: quickstart-uffizzi-ci.md
- Demo on Uffizzi button: guides/demo-on-uffizzi.md
- Set up your account: guides/set-up-your-account.md
- Expose multiple routes: guides/expose-multiple-routes.md
- Configure password-protected environments: guides/password-protected.md
- Authenticate with a container registry: guides/container-registry-integrations.md
- Add environment variables: guides/environment-variables.md
- Add secrets: guides/secrets.md
- Check logs: guides/logs.md
- Configure SSO: guides/single-sign-on.md
- Microservices on Uffizzi: guides/support-microservices-in-ephemeral-environments-with-nginx.md
- GitHub Environments: guides/github-environment.md
- Topics:
- Virtual Clusters: topics/virtual-clusters.md
- Teams and Accounts: topics/teams-and-accounts.md
- Role-based access (RBAC): topics/rbac.md
- Networking and architecture: topics/networking.md
- OpenID Connect (OIDC): topics/oidc.md
- Why Uffizzi?: topics/why-uffizzi.md
- Continuous Previews: topics/continuous-previews.md
- CI/CD + CP: topics/ci-cd-registry.md
- Single-Page Applications: topics/single-page-applications.md
- Docker Extensions Partner: topics/docker-extension-partner.md
- References:
- Command-line Reference: references/cli.md
- Docker Compose for Uffizzi: references/compose-spec.md
- Example Uffizzi Compose: references/example-compose.md
- Uffizzi CI: references/uffizzi-ci.md
- Uffizzi Environment URL: references/uffizzi-environment-variables.md
- Troubleshooting:
- Most common problems: troubleshooting/most-common-problems.md
- Debugging: troubleshooting/debugging.md
- File or Directory is Too Large Error: troubleshooting/file-or-directory-is-too-large.md