Skip to content

Commit 166bdb3

Browse files
author
Chris Chinchilla
authored
[DOCS] Separate config to allow for dev and prod setups (#2909)
1 parent 518d130 commit 166bdb3

File tree

3 files changed

+391
-2
lines changed

3 files changed

+391
-2
lines changed

‎site/config.toml renamed to ‎site/config/_default/config.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
[module]
33
[[module.imports]]
44
path = "github.com/chronosphereio/victor"
5-
# path = "../../../victor"
6-
5+
76
[[module.mounts]]
87
source = "content"
98
target = "content/docs"

‎site/config/development/config.toml

Lines changed: 195 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,195 @@
1+
# Change the default theme to be use when building the site with Hugo
2+
[module]
3+
[[module.imports]]
4+
path = "../../../victor"
5+
6+
[[module.mounts]]
7+
source = "content"
8+
target = "content/docs"
9+
10+
[[module.mounts]]
11+
source = "static"
12+
target = "static"
13+
14+
[[module.mounts]]
15+
source = "layouts"
16+
target = "layouts"
17+
18+
[[module.mounts]]
19+
source = "data"
20+
target = "data"
21+
22+
[[module.mounts]]
23+
source = "assets"
24+
target = "assets"
25+
26+
[[module.mounts]]
27+
source = "i18n"
28+
target = "i18n"
29+
30+
[[module.mounts]]
31+
source = "archetypes"
32+
target = "archetypes"
33+
34+
ignoreFiles = [ "\\.ttf$", "\\.woff$", "\\.woff2$", "\\.eot$" ]
35+
36+
[permalinks]
37+
"/" = "/docs/:section/:title/"
38+
"faqs" = "/docs/:section/:title/"
39+
"glossaries" = "/docs/:section/:title/"
40+
"how_tos" = "/docs/:section/:title/"
41+
"integrations" = "/docs/:section/:title/"
42+
"m3coordinators" = "/docs/:section/:title/"
43+
"m3dbs" = "/docs/:section/:title/"
44+
"m3querys" = "/docs/:section/:title/"
45+
"operational_guides" = "/docs/:section/:title/"
46+
"overviews" = "/docs/:section/:title/"
47+
"quickstarts" = "/docs/:section/:title/"
48+
"troubleshootings" = "/docs/:section/:title/"
49+
50+
# theme = "docs-theme"
51+
# baseURL = "/"
52+
languageCode = "en-US"
53+
defaultContentLanguage = "en"
54+
# staticDir = ["static"]
55+
56+
title = "M3DB Documentation"
57+
metaDataFormat = "yaml"
58+
defaultContentLanguageInSubdir= true
59+
60+
# Highlighting config.
61+
pygmentsCodeFences = true
62+
pygmentsUseClasses = false
63+
# Use the new Chroma Go highlighter in Hugo.
64+
pygmentsUseClassic = false
65+
#pygmentsOptions = "linenos=table"
66+
# See https://help.farbox.com/pygments.html
67+
# pygmentsStyle = "vs"
68+
69+
enableGitInfo = true
70+
71+
[frontmatter]
72+
# date = ["date", ":filename", "publishDate", "lastmod"]
73+
74+
# Image processing configuration.
75+
[imaging]
76+
resampleFilter = "CatmullRom"
77+
quality = 75
78+
anchor = "smart"
79+
80+
[services]
81+
[services.googleAnalytics]
82+
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
83+
# id = "UA-00000000-0"
84+
85+
#fullversion = "v1.18.0"
86+
#version = "v1.18"
87+
githubbranch = "master"
88+
docsbranch = "master"
89+
deprecated = false
90+
#currentUrl = "https://kubernetes.io/home/"
91+
#nextUrl = "https://kubernetes-io-vnext-staging.netlify.com/"
92+
githubWebsiteRepo = "https://github.com/m3db/m3"
93+
githubWebsiteRaw = "raw.githubusercontent.com/m3db/m3"
94+
95+
# Enable Algolia DocSearch
96+
# algolia_docsearch = false
97+
98+
# Enable Lunr.js offline search
99+
offlineSearch = false
100+
101+
[params]
102+
# Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page.
103+
# Useful to give opportunity to people to create merge request for your doc.
104+
# See the config.toml file from this documentation site to have an example.
105+
# TODO: pattern to branch?
106+
# TODO: bring back
107+
# editURL = "https://github.com/m3db/m3/tree/master/site/content/"
108+
# Author of the site, will be used in meta information
109+
author = "m3"
110+
# Description of the site, will be used in meta information
111+
description = "m3documentation"
112+
# Shows a checkmark for visited pages on the menu
113+
showVisitedLinks = false
114+
# Disable search function. It will hide search bar
115+
disableSearch = false
116+
# Javascript and CSS cache are automatically busted when new version of site is generated.
117+
# Set this to true to disable this behavior (some proxies don't handle well this optimization)
118+
disableAssetsBusting = false
119+
# Set this to true to disable copy-to-clipboard button for inline code.
120+
disableInlineCopyToClipBoard = true
121+
# A title for shortcuts in menu is set by default. Set this to true to disable it.
122+
disableShortcutsTitle = false
123+
# When using mulitlingual website, disable the switch language button.
124+
disableLanguageSwitchingButton = false
125+
# Hide breadcrumbs in the header and only show the current page title
126+
disableBreadcrumb = true
127+
# Hide Next and Previous page buttons normally displayed full height beside content
128+
disableNextPrev = true
129+
# Order sections in menu by "weight" or "title". Default to "weight"
130+
ordersectionsby = "weight"
131+
# Change default color scheme with a variant one. Can be "red", "blue", "green".
132+
themeVariant = "blue"
133+
twitter = "m3db_io"
134+
disableHomeIcon = true
135+
136+
[params.api]
137+
localCordinator = "http://localhost:7201/"
138+
apiEndpoint = "api/v1/"
139+
140+
# TODO: Might need to refactor some of the K8s shortcodes later
141+
# Add your release versions here
142+
# TODO: Enable when ready
143+
# [[params.versions]]
144+
# version = "1.0"
145+
# url = "https://master.kubeflow.org"
146+
# [[params.versions]]
147+
# version = "0.9"
148+
# url = "https://master.kubeflow.org"
149+
150+
# version_menu = "Versions"
151+
152+
# TODO: Do not like doing this really
153+
[markup]
154+
[markup.goldmark]
155+
[markup.goldmark.renderer]
156+
unsafe = true
157+
[markup.goldmark.parser]
158+
attribute = true
159+
autoHeadingID = true
160+
autoHeadingIDType = "github"
161+
[markup.tableOfContents]
162+
endLevel = 3
163+
ordered = false
164+
startLevel = 2
165+
[markup.goldmark.extensions]
166+
definitionList = true
167+
footnote = true
168+
linkify = true
169+
strikethrough = true
170+
table = true
171+
taskList = true
172+
typographer = true
173+
174+
[[menu.shortcuts]]
175+
pre = "<h3>More</h3>"
176+
name = "<i class='fa fa-github'></i> <label>Github repo</label>"
177+
identifier = "ds"
178+
url = "https://github.com/m3db/m3"
179+
weight = 10
180+
181+
[[menu.shortcuts]]
182+
name = "<i class='fa fa-slack'></i> <label>Slack</label>"
183+
url = "https://bit.ly/m3slack"
184+
weight = 11
185+
186+
[[menu.shortcuts]]
187+
name = "<i class='fa fa-inbox'></i> <label>Mailing list</label>"
188+
url = "https://groups.google.com/forum/#!forum/m3db"
189+
weight = 12
190+
191+
[outputs]
192+
home = [ "HTML", "RSS", "JSON"]
193+
page = [ "HTML"]
194+
section = [ "HTML"]
195+
chapter = [ "HTML"]

0 commit comments

Comments
 (0)