forked from armory/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.toml
352 lines (290 loc) · 10.6 KB
/
config.toml
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# This config.toml is used with Hugo <= 0.110.0
baseURL = "/"
enableRobotsTXT = true
enableInlineShortcodes = true
# Will give values to .Lastmod etc.
enableGitInfo = true
# Language settings
defaultContentLanguage = "en"
defaultContentLanguageInSubdir = false
# Useful when translating.
enableMissingTranslationPlaceholders = true
# Google Analytics configuration
# https://gohugo.io/templates/internal/#configure-google-analytics
# https://www.docsy.dev/docs/adding-content/feedback/#adding-analytics
googleAnalytics = 'G-W14B82N2D2'
#disableKinds = ["taxonomy", "taxonomyTerm"]
# Highlighting config (copied from the docsy example site, tag v0.7.1)
pygmentsCodeFences = true
pygmentsUseClasses = false
# Use the new Chroma Go highlighter in Hugo.
pygmentsUseClassic = false
#pygmentsOptions = "linenos=table"
# See https://help.farbox.com/pygments.html
pygmentsStyle = "dracula"
[markup]
[markup.tableOfContents]
endLevel = 4 # page TOC render ##, ###, #### headings
[markup.goldmark]
[markup.goldmark.parser.attribute]
block = true
[markup.goldmark.renderer]
unsafe = true
[markup.highlight]
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
style = "dracula"
# these are defaults https://gohugo.io/getting-started/configuration-markup/#highlight
anchorLineNos = false
codeFences = true
hl_Lines = ''
hl_inline = false
lineAnchors = ''
lineNoStart = 1
lineNos = false
lineNumbersInTable = true
noClasses = true
noHl = false
tabWidth = 4
guessSyntax = true
# Set guessSyntax to true if you want your chosen highlight style used for code blocks without a specified language
# Docsy is now a Go module; need to map theme dirs to local dirs
# 16 Aug 2023 When I remove the module.imports.mounts entries, compilation breaks with a lot of "not found" - can't find shortcodes or refs
[module]
proxy = "direct"
[module.hugoVersion]
extended = true
min = "0.110.0"
[[module.imports]]
path = "github.com/google/docsy"
disable = false
[[module.imports.mounts]]
source = "assets"
target = "assets"
[[module.imports.mounts]]
source = "node_modules/bootstrap"
target = "assets/vendor/bootstrap"
[[module.imports.mounts]]
source = "node_modules/@fortawesome/fontawesome-free"
target = "assets/vendor/Font-Awesome"
[[module.imports.mounts]]
source = "i18n"
target = "i18n"
[[module.imports.mounts]]
source = "layouts"
target = "layouts"
[[module.imports.mounts]]
source = "static"
target = "static"
[[module.imports.mounts]]
source = "data"
target = "data"
[[module.imports.mounts]]
source = "node_modules/@fortawesome/fontawesome-free/webfonts"
target = "static/webfonts"
[[module.imports]]
path = "github.com/google/docsy/dependencies"
disable = false
[[module.mounts]]
source = "content/en"
target = "content"
# Configure how URLs look like per section.
[permalinks]
blog = "/:section/:year/:month/:day/:slug/"
## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
[blackfriday]
plainIDAnchors = true
hrefTargetBlank = true
angledQuotes = false
latexDashes = true
# Image processing configuration.
[imaging]
resampleFilter = "CatmullRom"
quality = 75
anchor = "smart"
# Language configuration
[languages]
[languages.en]
#comment out title as it messes with the new logo
title = "Armory Docs"
description = "Unlocking Innovation by Making Software Delivery Continuous, Scalable, and Safe"
languageName ="English"
# Weight used for sorting.
weight = 1
[[menu.main]]
name = "CD-as-a-Service"
weight = 2
url = "https://developer.armory.io/"
[[menu.main]]
name = "Armory CD"
weight = 3
url = "/continuous-deployment/"
[[menu.main]]
name = "Spinnaker Plugins"
weight = 4
url = "/plugins/"
[[menu.main]]
name = "Support"
weight = 5
url = "https://support.armory.io/"
[[menu.main]]
name = "Blog"
weight = 6
url = "https://www.armory.io/blog/"
[[menu.main]]
name = "Armory.io"
weight = 7
url = "https://www.armory.io/"
[[menu.main]]
name = "Contribute"
weight = 10
url = "/contribute/"
# Everything below this are Site Params
[params]
# See codenew shortcode
deploy-engine-plugin-version = "0.16.8"
armory-version = "2.34.x"
#used in air-gapped
matching-oss-version-exact = "1.27.0"
# used in agent compat and system requirements
mysql-version="5.7; AWS Aurora"
postgresql-version="10+"
#used in the Operator docs
armory-version-exact = "2.34"
halyard-armory-version = "1.12.1"
kubesvc-version="1.0.83"
operator-extended-crd-version = "v1alpha2"
operator-oss-crd-version = "v1alpha2"
opa-server-version = "0.28.0"
copyright = "Armory Inc."
privacy_policy = "https://www.armory.io/privacy-policy/"
terms_of_service = "https://www.armory.io/terms-of-service/"
terms_and_conditions = "https://www.armory.io/terms-and-conditions/"
# First one is picked as the Twitter card image if not set on page.
# images = ["images/project-illustration.png"]
# Menu title if your navbar has a versions selector to access old versions of your site.
# This menu appears only if you have at least one [params.versions] set.
version_menu = "Armory CD v2.34"
# Flag used in the "version-banner" partial to decide whether to display a
# banner on every page indicating that this is an archived version of the docs.
# Set this flag to "true" if you want to display the banner.
archived_version = false
# The version number for the version of the docs represented in this doc set.
# Used in the "version-banner" partial to display a version number for the
# current doc set.
# Also used in the PCM to highlight what version the PCM is for
version = "2.34.x"
# A link to latest version of the Armory CD docs. Used in the "version-banner" partial to
# point people to the main Armory CD docs site.
url_latest_version = "https://docs.armory.io/continuous-deployment/"
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo = "https://github.com/armory/docs/"
github_branch = "master"
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
#github_project_repo = "https://github.com/armory"
# Specify a value here if your content directory is not in your repo's root directory
# github_subdir = ""
# Google Custom Search Engine ID. Remove or comment out to disable search.
# gcs_engine_id = "011737558837375720776:fsdu1nryfng"
# Enable Algolia DocSearch
algolia_docsearch = false
# Enable Lunr.js offline search
offlineSearch = true
offlineSearchMaxResults = 50
offlineSearchSummaryLength = 200
# Armory Agent plugin versions
[params.kubesvc-plugin]
agent_plug_latest-5="0.11.56"
agent_plug_latest_spin-5="2.28.x (1.28.x)"
agent_plug_latest-4="0.12.21"
agent_plug_latest_spin-4="1.29.x"
agent_plug_latest-3="0.13.20"
agent_plug_latest_spin-3="2.30.x (1.30.x)"
agent_plug_latest-2="0.14.1"
agent_plug_latest_spin-2="2.31.x (1.31.x)"
agent_plug_latest-1="0.14.1"
agent_plug_latest_spin-1="2.32.x (1.32.x)"
agent_plug_latest="0.15.0"
agent_plug_latest_spin="2.34.x (1.34.x)"
# Policy Engine plugin versions
[params.policy-engine-plugin]
pe_plug_latest="0.3.0"
pe_plug_latest_spin="2.28.x (1.28.x)"
pe_plug_latest-1="0.2.2"
pe_plug_latest_spin-1="2.27.x (1.27.x)"
pe_plug_latest-2="0.1.6"
pe_plug_latest_spin-2="2.26.x (1.26.x)"
# User interface configuration
[params.ui]
# Enable to show the side bar menu in its compact state.
sidebar_menu_compact = true
sidebar_menu_foldable= true
sidebar_cache_limit = 10
# Set to true to disable breadcrumb navigation.
breadcrumb_disable = false
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
sidebar_search_disable = false
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
navbar_logo = true
# Set to true to disable the About link in the site footer
footer_about_disable = false
# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
# add "hide_feedback: true" to the page's front matter.
[params.ui.feedback]
enable = true
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
yes = 'Thank you for letting us know!'
no = 'Sorry to hear that. Please <a href="https://github.com/armory/docs/issues/new">tell us how we can improve</a>.'
# Adds a reading time to the top of each doc.
# If you want this feature, but occasionally need to remove the Reading time from a single page,
# add "hide_readingtime: true" to the page's front matter
[params.ui.readingtime]
enable = false
# Enable Mermaid diagrams
# With hugo version 0.93 or higher, support of Mermaid diagrams is automatically enabled as soon as you use a mermaid code block on your page.
[params.mermaid]
# enable = true
theme = "forest"
[params.links]
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
[[params.links.user]]
name = "Email Armory"
url = "mailto:[email protected]"
icon = "fa fa-envelope"
desc = "Discussion and help from your fellow users"
[[params.links.user]]
name ="Twitter"
url = "https://twitter.com/cloudarmory"
icon = "fab fa-twitter"
desc = "Follow us on Twitter to get the latest news!"
[[params.links.user]]
name ="RSS"
url = "https://docs.armory.io/index.xml"
icon = "fas fa-rss"
desc = "Follow us on RSS to get the latest docs updates!"
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
[[params.links.developer]]
name = "GitHub"
url = "https://github.com/armory/docs/"
icon = "fab fa-github"
desc = "Docs repository"
[[params.links.developer]]
name = "Slack"
url = "https://join.slack.com/t/spinnakerteam/shared_invite/zt-7juwxmx0-nQ4Ud4pJcbuPykX3SXwQrg"
icon = "fab fa-slack"
desc = "Chat with Armory users and developers in the Spinnaker Slack"
#Add new release versions here. These entries appear in the drop-down menu
# at the top of the website.
[[params.versions]]
version = "Armory CD v2.31"
githubbranch = "v2.31"
url = "https://v2-31.docs.armory.io/continuous-deployment/"
[[params.versions]]
version = "Armory CD v2.30"
githubbranch = "v2.30"
url = "https://v2-30.docs.armory.io/continuous-deployment/"
[[params.versions]]
version = "Armory CD v2.28"
githubbranch = "v2.28"
url = "https://v2-28.docs.armory.io/continuous-deployment/"