Skip to content

Commit

Permalink
Fix rendering issues
Browse files Browse the repository at this point in the history
Signed-off-by: ChrisChinchilla <chris@chronosphere.io>
  • Loading branch information
ChrisChinchilla committed Dec 3, 2020
1 parent c34d20d commit 2286889
Show file tree
Hide file tree
Showing 21 changed files with 104 additions and 196 deletions.
12 changes: 11 additions & 1 deletion 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 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/content/cluster/binaries_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ We recommend a replication factor of **3**, with each replica spread across fail

Read the [placement configuration guide](/docs/operational_guide/placement_configuration) to determine the appropriate number of shards to specify.

{{% fileinclude file="getting-started/common-steps.md" %}}
{{< fileinclude file="cluster-common-steps.md" >}}

<!-- ## Next Steps

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion site/content/cluster/kubernetes_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,4 @@ kubectl delete m3dbcluster simple-cluster

By default, the operator uses [finalizers](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#finalizers) to delete the placement and namespaces associated with a cluster before the custom resources. If you do not want this behavior, set `keepEtcdDataOnDelete` to `true` in the cluster configuration.

{{% fileinclude file="quickstart/common-steps.md" %}}
{{< fileinclude file="cluster-common-steps.md" >}}
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,17 @@ Label names may contain ASCII letters, numbers, underscores, and Unicode charact
{{< tabs name="write_metrics" >}}
{{< tab name="Command 1" >}}

{{% codeinclude file="quickstart/write-metrics-1.sh" language="shell" %}}
{{< codeinclude file="docs/includes/write-metrics-1.sh" language="shell" >}}

{{< /tab >}}
{{< tab name="Command 2" >}}

{{% codeinclude file="quickstart/write-metrics-2.sh" language="shell" %}}
{{< codeinclude file="docs/includes/write-metrics-2.sh" language="shell" >}}

{{< /tab >}}
{{< tab name="Command 3" >}}

{{% codeinclude file="quickstart/write-metrics-3.sh" language="shell" %}}
{{< codeinclude file="docs/includes/write-metrics-3.sh" language="shell" >}}

{{< /tab >}}
{{< /tabs >}}
Expand Down
6 changes: 6 additions & 0 deletions site/content/includes/create-database.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/bin/bash
curl -X POST http://localhost:7201/api/v1/database/create -d '{
"type": "local",
"namespaceName": "default",
"retentionTime": "12h"
}' | jq .
22 changes: 0 additions & 22 deletions site/content/includes/podtemplate.json

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ The `namespaceName` argument must match the namespace in the `local` section of
In another terminal, use the following command.

{{< tabs name="create_placement_namespace" >}}
{{% tab name="Command" %}}
{{< tab name="Command" >}}

{{% codeinclude file="quickstart/create-database.sh" language="shell" %}}
{{< codeinclude file="docs/includes/create-database.sh" language="shell" >}}

{{% /tab %}}
{{< /tab >}}
{{% tab name="Output" %}}

```json
Expand Down Expand Up @@ -111,7 +111,7 @@ In another terminal, use the following command.
}
```

{{< /tab >}}
{{% /tab %}}
{{< /tabs >}}

Placement initialization can take a minute or two. Once all the shards have the `AVAILABLE` state, the node has finished bootstrapping, and you should see the following messages in the node console output.
Expand Down Expand Up @@ -274,17 +274,17 @@ Label names may contain ASCII letters, numbers, underscores, and Unicode charact
{{< tabs name="write_metrics" >}}
{{< tab name="Command 1" >}}

{{% codeinclude file="quickstart/write-metrics-1.sh" language="shell" %}}
{{< codeinclude file="docs/includes/write-metrics-1.sh" language="shell" >}}

{{< /tab >}}
{{< tab name="Command 2" >}}

{{% codeinclude file="quickstart/write-metrics-2.sh" language="shell" %}}
{{< codeinclude file="docs/includes/write-metrics-2.sh" language="shell" >}}

{{< /tab >}}
{{< tab name="Command 3" >}}

{{% codeinclude file="quickstart/write-metrics-3.sh" language="shell" %}}
{{< codeinclude file="docs/includes/write-metrics-3.sh" language="shell" >}}

{{< /tab >}}
{{< /tabs >}}
Expand Down
11 changes: 11 additions & 0 deletions site/content/includes/write-metrics-1.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#!/bin/bash
curl -X POST http://localhost:7201/api/v1/json/write -d '{
"tags":
{
"__name__": "third_avenue",
"city": "new_york",
"checkout": "1"
},
"timestamp": '\"$(date "+%s")\"',
"value": 3347.26
}'
11 changes: 11 additions & 0 deletions site/content/includes/write-metrics-2.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#!/bin/bash
curl -X POST http://localhost:7201/api/v1/json/write -d '{
"tags":
{
"__name__": "third_avenue",
"city": "new_york",
"checkout": "1"
},
"timestamp": '\"$(date "+%s")\"',
"value": 5347.26
}'
11 changes: 11 additions & 0 deletions site/content/includes/write-metrics-3.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#!/bin/bash
curl -X POST http://localhost:7201/api/v1/json/write -d '{
"tags":
{
"__name__": "third_avenue",
"city": "new_york",
"checkout": "1"
},
"timestamp": '\"$(date "+%s")\"',
"value": 7347.26
}'
2 changes: 1 addition & 1 deletion site/content/quickstart/binaries.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,4 @@ The file groups configuration into `coordinator` or `db` sections that represent
You can find more information on configuring M3DB in the [operational guides section](/docs/operational_guide).
{{% /notice %}}

{{% fileinclude file="quickstart/common-steps.md" %}}
{{< fileinclude file="quickstart-common-steps.md" >}}
6 changes: 6 additions & 0 deletions site/content/quickstart/create-database.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/bin/bash
curl -X POST http://localhost:7201/api/v1/database/create -d '{
"type": "local",
"namespaceName": "default",
"retentionTime": "12h"
}' | jq .
2 changes: 1 addition & 1 deletion site/content/quickstart/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ docker run -p 7201:7201 -p 7203:7203 --name m3db -v $(pwd)/m3db_data:/var/lib/m3
When running the command above on Docker for Mac, Docker for Windows, and some Linux distributions you may see errors about settings not being at recommended values. Unless you intend to run M3DB in production on macOS or Windows, you can ignore these warnings.
{{% /notice %}}

{{% fileinclude file="quickstart/common-steps.md" %}}
{{< fileinclude file="quickstart-common-steps.md" >}}
11 changes: 11 additions & 0 deletions site/content/quickstart/write-metrics-1.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#!/bin/bash
curl -X POST http://localhost:7201/api/v1/json/write -d '{
"tags":
{
"__name__": "third_avenue",
"city": "new_york",
"checkout": "1"
},
"timestamp": '\"$(date "+%s")\"',
"value": 3347.26
}'
11 changes: 11 additions & 0 deletions site/content/quickstart/write-metrics-2.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#!/bin/bash
curl -X POST http://localhost:7201/api/v1/json/write -d '{
"tags":
{
"__name__": "third_avenue",
"city": "new_york",
"checkout": "1"
},
"timestamp": '\"$(date "+%s")\"',
"value": 5347.26
}'
11 changes: 11 additions & 0 deletions site/content/quickstart/write-metrics-3.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#!/bin/bash
curl -X POST http://localhost:7201/api/v1/json/write -d '{
"tags":
{
"__name__": "third_avenue",
"city": "new_york",
"checkout": "1"
},
"timestamp": '\"$(date "+%s")\"',
"value": 7347.26
}'

0 comments on commit 2286889

Please sign in to comment.