forked from openfaas/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
164 lines (149 loc) · 5.34 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
# Copyright (c) 2016-2017 Martin Donath <[email protected]>
# Copyright (c) 2018 OpenFaaS Author(s)
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
# Project information
site_name: OpenFaaS
site_description: OpenFaaS - Serverless Functions Made Simple
site_author: OpenFaaS Project
site_url: https://www.openfaas.com/
# Repository
repo_name: openfaas/faas
repo_url: https://github.com/openfaas/faas
edit_uri: ""
# edit_uri: edit/docs-revamp/docs/
# edit_uri: blob/docs-revamp/docs/
# remote_name: origin
# remote_branch: gh-pages
# Theme and overrides, i.e. language partial
theme:
name: material
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
# Default values, taken from mkdocs_theme.yml
language: en
feature:
tabs: false
palette:
primary: blue
accent: indigo
favicon: images/favicon.ico
logo: images/logo.svg
# Copyright
copyright: "Copyright © 2019 OpenFaaS Project"
# Options
extra:
search:
languages: "en"
social:
- type: globe
link: https://www.openfaas.com/
- type: github-alt
link: https://github.com/openfaas
- type: twitter
link: https://twitter.com/openfaas
extra_css:
- stylesheets/extra.css
# Extensions
markdown_extensions:
- markdown.extensions.admonition
- markdown.extensions.codehilite:
guess_lang: false
- markdown.extensions.def_list
- markdown.extensions.footnotes
- markdown.extensions.meta
- markdown.extensions.toc:
permalink: true
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:pymdownx.emoji.to_svg
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
# Page tree
nav:
- Overview:
- Introduction: index.md
- Community: community.md
- Getting Started:
- Deployment: deployment.md
- Kubernetes: ./deployment/kubernetes.md
- OpenShift: ./deployment/openshift.md
- Docker Swarm: ./deployment/docker-swarm.md
- Docker Playground: ./deployment/play-with-docker.md
- Troubleshooting: ./deployment/troubleshooting.md
- CLI:
- Installation: ./cli/install.md
- Create functions: ./cli/templates.md
- Build functions: ./cli/build.md
- Manage secrets: ./cli/secrets.md
- Logs: ./cli/logs.md
- Working with image tags: ./cli/tags.md
- Shell auto completion: ./cli/completion.md
- Reference:
- CI/CD:
- Intro: ./reference/cicd/intro.md
- GitLab: ./reference/cicd/gitlab.md
- Jenkins: ./reference/cicd/jenkins.md
- SSL:
- Kubernetes: ./reference/ssl/kubernetes-with-cert-manager.md
- Secrets: ./reference/secrets.md
- Async: ./reference/async.md
- Triggers: ./reference/triggers.md
- Workloads: ./reference/workloads.md
- Auth: ./reference/authentication.md
- CORS: ./reference/cors.md
- Cron: ./reference/cron.md
- Log Providers: ./reference/logs/providers.md
- YAML: ./reference/yaml.md
- OpenFaaS Cloud:
- Intro: ./openfaas-cloud/intro.md
- Community Cluster: ./openfaas-cloud/community-cluster.md
- User Guide: ./openfaas-cloud/user-guide.md
- Manage secrets: ./openfaas-cloud/secrets.md
- Self-hosted:
- Configure GitHub: ./openfaas-cloud/self-hosted/github.md
- Configure GitLab: ./openfaas-cloud/self-hosted/gitlab.md
- Troubleshooting: ./openfaas-cloud/self-hosted/troubleshoot.md
- Design & Architecture:
- Stack: ./architecture/stack.md
- Gateway: ./architecture/gateway.md
- Watchdog: ./architecture/watchdog.md
- Autoscaling: ./architecture/autoscaling.md
- Metrics: ./architecture/metrics.md
- Performance: ./architecture/performance.md
- Production: ./architecture/production.md
- Tutorials:
- Workshop: ./tutorials/workshop.md
- CLI with Node.js: ./tutorials/CLI-with-node.md
- First Python Function: ./tutorials/first-python-function.md
- Test Drive: ./tutorials/test-drive.md
- Kubernetes HPAv2: ./tutorials/kubernetes-hpa.md
- Featured: ./tutorials/featured.md
- Contributing:
- Get Started: ./contributing/get-started.md
- Code Repositories: ./contributing/code-repositories.md