Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Update theme to add section layouts #3004

Closed
wants to merge 10 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ require (
github.com/golang/mock v1.4.4
github.com/golang/protobuf v1.4.2
github.com/golang/snappy v0.0.1
github.com/golangci/golangci-lint v1.33.0 // indirect
github.com/google/go-cmp v0.5.2
github.com/google/go-jsonnet v0.16.0
github.com/google/uuid v1.1.2-0.20190416172445-c2e93f3ae59f // indirect
Expand Down
191 changes: 191 additions & 0 deletions go.sum

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,14 @@
from = "/docs/how_to/single_node"
to = "docs/quickstart"

[[redirects]]
from="docs/how_to/kubernetes"
to="/docs/getting_started/kubernetes_cluster"

[[redirects]]
from="docs/quickstart/kubernetes"
to="/docs/cluster/kubernetes_cluster"

# TODO: Fix this with new content type
[[redirects]]
from = "/talks"
Expand Down
14 changes: 12 additions & 2 deletions site/config/_default/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,18 @@ metaDataFormat = "yaml"
# baseURL = "/"
languageCode = "en-US"
defaultContentLanguage = "en"
defaultContentLanguageInSubdir = true
# staticDir = ["static"]
defaultContentLanguageInSubdir= true
# defaultContentLanguageInSubdir= true

[languages]
[languages.en]
title = "Kubernetes"
description = "Production-Grade Container Orchestration"
languageName ="English"
# Weight used for sorting.
weight = 1
languagedirection = "ltr"

# Highlighting config.
pygmentsCodeFences = true
Expand All @@ -49,7 +59,7 @@ pygmentsUseClassic = false
#pygmentsOptions = "linenos=table"
# See https://help.farbox.com/pygments.html
# pygmentsStyle = "vs"
enableGitInfo = true
# enableGitInfo = true

[permalinks]
"/" = "/docs/:section/:filename/"
Expand Down
160 changes: 1 addition & 159 deletions site/config/development/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,162 +29,4 @@

[[module.mounts]]
source = "archetypes"
target = "archetypes"

ignoreFiles = [ "\\.ttf$", "\\.woff$", "\\.woff2$", "\\.eot$" ]

[permalinks]
"/" = "/docs/:section/:title/"
"faqs" = "/docs/:section/:title/"
"glossaries" = "/docs/:section/:title/"
"how_tos" = "/docs/:section/:title/"
"integrations" = "/docs/:section/:title/"
"m3coordinators" = "/docs/:section/:title/"
"m3dbs" = "/docs/:section/:title/"
"m3querys" = "/docs/:section/:title/"
"operational_guides" = "/docs/:section/:title/"
"overviews" = "/docs/:section/:title/"
"quickstarts" = "/docs/:section/:title/"
"troubleshootings" = "/docs/:section/:title/"

# theme = "docs-theme"
# baseURL = "/"
languageCode = "en-US"
defaultContentLanguage = "en"
# staticDir = ["static"]

metaDataFormat = "yaml"
defaultContentLanguageInSubdir= true

# Highlighting config.
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 = "vs"

enableGitInfo = true

[frontmatter]
# date = ["date", ":filename", "publishDate", "lastmod"]

# Image processing configuration.
[imaging]
resampleFilter = "CatmullRom"
quality = 75
anchor = "smart"

[services]
[services.googleAnalytics]
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
# id = "UA-00000000-0"

#fullversion = "v1.18.0"
#version = "v1.18"
githubbranch = "master"
docsbranch = "master"
deprecated = false
#currentUrl = "https://kubernetes.io/home/"
#nextUrl = "https://kubernetes-io-vnext-staging.netlify.com/"
githubWebsiteRepo = "https://github.com/m3db/m3"
githubWebsiteRaw = "raw.githubusercontent.com/m3db/m3"

# Enable Algolia DocSearch
# algolia_docsearch = false

# Enable Lunr.js offline search
offlineSearch = false

[params]
# Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page.
# Useful to give opportunity to people to create merge request for your doc.
# See the config.toml file from this documentation site to have an example.
# TODO: pattern to branch?
# TODO: bring back
# editURL = "https://github.com/m3db/m3/tree/master/site/content/"
# Shows a checkmark for visited pages on the menu
showVisitedLinks = false
# Disable search function. It will hide search bar
disableSearch = false
# Javascript and CSS cache are automatically busted when new version of site is generated.
# Set this to true to disable this behavior (some proxies don't handle well this optimization)
disableAssetsBusting = false
# Set this to true to disable copy-to-clipboard button for inline code.
disableInlineCopyToClipBoard = true
# A title for shortcuts in menu is set by default. Set this to true to disable it.
disableShortcutsTitle = false
# When using mulitlingual website, disable the switch language button.
disableLanguageSwitchingButton = false
# Hide breadcrumbs in the header and only show the current page title
disableBreadcrumb = true
# Hide Next and Previous page buttons normally displayed full height beside content
disableNextPrev = true
# Order sections in menu by "weight" or "title". Default to "weight"
ordersectionsby = "weight"
# Change default color scheme with a variant one. Can be "red", "blue", "green".
themeVariant = "blue"
twitter = "m3db_io"
disableHomeIcon = true

[params.api]
localCordinator = "http://localhost:7201/"
apiEndpoint = "api/v1/"

# TODO: Might need to refactor some of the K8s shortcodes later
# Add your release versions here
# TODO: Enable when ready
# [[params.versions]]
# version = "1.0"
# url = "https://master.kubeflow.org"
# [[params.versions]]
# version = "0.9"
# url = "https://master.kubeflow.org"

# version_menu = "Versions"

# TODO: Do not like doing this really
[markup]
[markup.goldmark]
[markup.goldmark.renderer]
unsafe = true
[markup.goldmark.parser]
attribute = true
autoHeadingID = true
autoHeadingIDType = "github"
[markup.tableOfContents]
endLevel = 3
ordered = false
startLevel = 2
[markup.goldmark.extensions]
definitionList = true
footnote = true
linkify = true
strikethrough = true
table = true
taskList = true
typographer = true

[[menu.shortcuts]]
pre = "<h3>More</h3>"
name = "<i class='fa fa-github'></i> <label>Github repo</label>"
identifier = "ds"
url = "https://github.com/m3db/m3"
weight = 10

[[menu.shortcuts]]
name = "<i class='fa fa-slack'></i> <label>Slack</label>"
url = "https://bit.ly/m3slack"
weight = 11

[[menu.shortcuts]]
name = "<i class='fa fa-inbox'></i> <label>Mailing list</label>"
url = "https://groups.google.com/forum/#!forum/m3db"
weight = 12

[outputs]
home = [ "HTML", "RSS", "JSON"]
page = [ "HTML"]
section = [ "HTML"]
chapter = [ "HTML"]
target = "archetypes"
2 changes: 1 addition & 1 deletion site/config/production/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ pygmentsUseClassic = false
# See https://help.farbox.com/pygments.html
# pygmentsStyle = "vs"

enableGitInfo = true
# enableGitInfo = true

[frontmatter]
# date = ["date", ":filename", "publishDate", "lastmod"]
Expand Down
2 changes: 1 addition & 1 deletion site/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ M3 has several features, provided as discrete components, which make it an ideal
Getting started with M3 is as easy as following one of the How-To guides.

- [Single M3DB node deployment](/docs/quickstart)
- [Clustered M3DB deployment](/docs/how_to/cluster_hard_way)
- [Clustered M3DB deployment](/docs/cluster)
- [M3DB on Kubernetes](/docs/operator)
- [Isolated M3Query on deployment](/docs/how_to/query)

Expand Down
6 changes: 6 additions & 0 deletions site/content/cluster/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
+++
title = "Create a Cluster"
date = 2020-04-01T19:26:56-04:00
weight = 2
chapter = true
+++
Loading