Skip to content

Commit

Permalink
[DOCS] Add clustering getting started guides for binaries and kuberne…
Browse files Browse the repository at this point in the history
…tes (#2795)

* Move other quickstarts

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Move configuration from common steps as it no longer matches k8s steps

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Squashed commit of the following:

commit cfffc26414de48e6e5d4784f0908aaebb19743fe
Author: ChrisChinchilla <chris@chronosphere.io>
Date:   Mon Oct 26 15:57:52 2020 +0100

    wip

    Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

commit e8b9766
Author: ChrisChinchilla <chris@chronosphere.io>
Date:   Mon Oct 26 15:53:36 2020 +0100

    Move previous guides to clustering quickstart section

    Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Update section

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Fix links

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Fix links add redirects

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Remove aggregator mention

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Remove aggregator mention

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Refactor

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Remove Docker fo rnow

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Remove and correct broken links

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Revert "Remove Docker fo rnow"

This reverts commit 7b56da1.

Fix more broken links

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Draft docker guide

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Remove duplicate content

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Remove embedded cluster note

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Move other quickstarts

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Squashed commit of the following:

commit cfffc26414de48e6e5d4784f0908aaebb19743fe
Author: ChrisChinchilla <chris@chronosphere.io>
Date:   Mon Oct 26 15:57:52 2020 +0100

    wip

    Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

commit e8b9766
Author: ChrisChinchilla <chris@chronosphere.io>
Date:   Mon Oct 26 15:53:36 2020 +0100

    Move previous guides to clustering quickstart section

    Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Update section

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Fix links

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Fix links add redirects

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Remove aggregator mention

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Remove aggregator mention

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Refactor

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Remove and correct broken links

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

Respond to feedback

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

* Fix rendering issues

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

* Update theme

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

* Remove failing git info flag

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

* Fix links

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

* Respond to feedback

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

* Respond to feedback and fix rebased files

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

* Remove helm mentions

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

* Respond to feedback

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

* Fix link

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

* Update theme to version 0.2.2

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>

* Tidy Go mods

Signed-off-by: ChrisChinchilla <chris@chronosphere.io>
  • Loading branch information
Chris Chinchilla authored Dec 14, 2020
1 parent 8dcdcaa commit ba38c8b
Show file tree
Hide file tree
Showing 37 changed files with 1,286 additions and 946 deletions.
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

0 comments on commit ba38c8b

Please sign in to comment.