unionai-docs-infra/hugo.site.toml at main · unionai/unionai-docs-infra · 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
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
# hugo.site.toml - Configurations for the site content
#
# ** DO NOT OVERRIDE ANY SETTING FROM hugo.toml. IT WILL NOT WORK **
#
# Also, do *not* introduce new variables here without a counterpart in
# hugo.toml, to avoid conflicts with future builds.
#
#   An exception to this rule is to add new values to maps, such as keys.
#
#   In other words, introducing a new [params.xxx] is a no-no, but
#   [params.yyy.zzz] whenever yyy exists is okay to add new zzz.

title = 'Union.ai Docs'

[params]
_merge = "deep"
signup_link = "https://www.union.ai/pricing"
docs_root = "https://www.union.ai/docs"
# Site-level description for the homepage's structured data and meta tags. The homepage is a
# redirect stub, so its front-matter description is "Redirect to User guide" — which was
# leaking into WebSite.description in the JSON-LD (DOC-1287).
site_description = "Documentation for Union.ai and Flyte: build, deploy and run AI and machine-learning workflows at scale."

custom_css = [
  "404.css",
  "api.css",
  "base.css",
  "breadcrumb.css",
  "flyte-banner.css",
  "card.css",
  "chroma.css",
  "codeblock.css",
  "footer.css",
  "header.css",
  "heading.css",
  "images.css",
  "key.css",
  "markdown.css",
  "mermaid.css",
  "plugin.css",
  "search-modal.css",
  "search.css",
  "sidebar.css",
  "toc.css",
]
custom_js = [
  "404.js",
  "key.js",
  "sidebar.js",
  "theme.js",
  "tags.js",
  "inline-code-linker.js",
  "codeblock-linker.js",
  "codeblock-copy-strip.js",
  "image-lightbox.js",
  "page-actions.js",
]

[params.variant_weights]
flyte = 2
union = 1


#----------------------------------------------------------
# Keywords

#
# Used by {{< key >}} shortcode. See:
# https://www.union.ai/docs/v2/flyte/community/contributing-docs/variants/#key
#
# ===== IMPORTANT =====
#
# DO NOT add new keys here without, in the same PR, adding them to the
# documentation above as well.
#
[params.key]

[params.key.default_project]
flyte = "flytesnacks"
union = "flytesnacks"

[params.key.product_full_name]
flyte = "Flyte OSS"
union = "Union.ai"

[params.key.product_name]
flyte = "Flyte"
union = "Union.ai"

[params.key.product]
flyte = "flyte"
union = "union"

[params.key.kit_name]
flyte = "Flytekit"
union = "Union"

[params.key.kit]
flyte = "flytekit"
union = "union"

[params.key.kit_as]
flyte = "fl"
union = "union"

[params.key.kit_import]
flyte = "flytekit as fl"
union = "union"

[params.key.kit_remote]
flyte = "FlyteRemote"
union = "UnionRemote"

[params.key.cli_name]
flyte = "Pyflyte"
union = "Union"

[params.key.cli]
flyte = "pyflyte"
union = "union"

[params.key.ctl_name]
flyte = "Flytectl"
union = "Uctl"

[params.key.ctl]
flyte = "flytectl"
union = "uctl"

[params.key.config_env]
flyte = "FLYTECTL_CONFIG"
union = "UNION_CONFIG"

[params.key.env_prefix]
flyte = "FLYTE"
union = "UNION"

[params.key.docs_home]
flyte = "https://www.union.ai/docs/flyte"
union = "https://www.union.ai/docs/union"

[params.key.map_func]
flyte = "map_task"
union = "map"

[params.key.logo]
flyte = "icon-logo-flyte.svg"
union = "icon-logo.svg"

[params.key.favicon]
flyte = "icon-logo-flyte.svg"
union = "favicon.ico"

# Please DO NOT add new keys without documenting them the contributing guide in the same PR.