[docs] Update theme rebased (#2899)

m3db · Nov 16, 2020 · cc78224 · cc78224
1 parent 5edd3f1
commit cc78224
Show file tree

Hide file tree

Showing 136 changed files with 1,350 additions and 622 deletions.
diff --git a/site/config.toml b/site/config.toml
@@ -1,12 +1,12 @@
 # Change the default theme to be use when building the site with Hugo
 [module]
   [[module.imports]]
-    path = "github.com/chronosphereio/docs-theme"
-    # path = "../../../docs-theme"
+    path = "github.com/chronosphereio/victor"
+    # path = "../../../victor"
 
   [[module.mounts]]
     source = "content"
-    target = "content"
+    target = "content/docs"
 
   [[module.mounts]]
     source = "static"
@@ -32,8 +32,23 @@
     source = "archetypes"
     target = "archetypes"
 
-# theme = "docs-theme"
+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"
@@ -89,7 +104,8 @@ offlineSearch = false
   # 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?
-  editURL = "https://github.com/m3db/m3/tree/master/site/content/"
+  # TODO: bring back
+  # editURL = "https://github.com/m3db/m3/tree/master/site/content/"
   # Author of the site, will be used in meta information
   author = "m3"
   # Description of the site, will be used in meta information
@@ -116,6 +132,7 @@ offlineSearch = false
   # 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/"
@@ -155,12 +172,23 @@ offlineSearch = false
       taskList = true
       typographer = true
 
-[[Languages.en.menu.shortcuts]]
-name = "<i class='fab fa-fw fa-github'></i> GitHub"
+[[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"]

diff --git a/site/content/_index.md b/site/content/_index.md
@@ -0,0 +1,42 @@
+---
+title: M3 Documentation
+weight: 1
+---
+
+
+## About
+
+After using open-source metrics solutions and finding issues with them at scale – such as reliability, cost, and
+operational complexity – [M3](https://github.com/m3db/m3) was created from the ground up to provide Uber with a
+native, distributed time series database, a highly-dynamic and performant aggregation service, a query engine, and
+other supporting infrastructure.
+
+## Key Features
+
+M3 has several features, provided as discrete components, which make it an ideal platform for time series data at scale:
+
+-   A distributed time series database, [M3DB](/docs/m3db/), that provides scalable storage for time series data and a reverse index.
+-   A sidecar process, [M3Coordinator](/docs/integrations/prometheus), that allows M3DB to act as the long-term storage for Prometheus.
+-   A distributed query engine, [M3Query](/docs/m3query), with native support for PromQL and Graphite (M3QL coming soon).
+    <!-- Add M3Aggregator link -->
+-   An aggregation tier, M3Aggregator, that runs as a dedicated metrics aggregator/downsampler allowing metrics to be stored at various retentions at different resolutions.
+
+## Getting Started
+
+**Note:** Make sure to read our [Operational Guides](/docs/operational_guide) before running in production!
+
+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)
+-   [M3DB on Kubernetes](/docs/operator)
+-   [Isolated M3Query on deployment](/docs/how_to/query)
+
+## Support
+
+For support with any issues, questions about M3 or its operation, or to leave any comments, the team can be
+reached in a variety of ways:
+
+-   [Slack (main chat channel)](http://bit.ly/m3slack)
+-   [Email](https://groups.google.com/forum/#!forum/m3db)
+-   [Github issues](https://github.com/m3db/m3/issues)
diff --git a/site/content/docs.md b/site/content/docs.md
@@ -0,0 +1,43 @@
+---
+title: M3 Introduction
+weight: 1
+permalink: /docs/
+---
+
+
+## About
+
+After using open-source metrics solutions and finding issues with them at scale – such as reliability, cost, and
+operational complexity – [M3](https://github.com/m3db/m3) was created from the ground up to provide Uber with a
+native, distributed time series database, a highly-dynamic and performant aggregation service, a query engine, and
+other supporting infrastructure.
+
+## Key Features
+
+M3 has several features, provided as discrete components, which make it an ideal platform for time series data at scale:
+
+-   A distributed time series database, [M3DB](/docs/m3db/), that provides scalable storage for time series data and a reverse index.
+-   A sidecar process, [M3Coordinator](/docs/integrations/prometheus), that allows M3DB to act as the long-term storage for Prometheus.
+-   A distributed query engine, [M3Query](/docs/m3query), with native support for PromQL and Graphite (M3QL coming soon).
+    <!-- Add M3Aggregator link -->
+-   An aggregation tier, M3Aggregator, that runs as a dedicated metrics aggregator/downsampler allowing metrics to be stored at various retentions at different resolutions.
+
+## Getting Started
+
+**Note:** Make sure to read our [Operational Guides](/docs/operational_guide) before running in production!
+
+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)
+-   [M3DB on Kubernetes](/docs/operator)
+-   [Isolated M3Query on deployment](/docs/how_to/query)
+
+## Support
+
+For support with any issues, questions about M3 or its operation, or to leave any comments, the team can be
+reached in a variety of ways:
+
+-   [Slack (main chat channel)](http://bit.ly/m3slack)
+-   [Email](https://groups.google.com/forum/#!forum/m3db)
+-   [Github issues](https://github.com/m3db/m3/issues)
diff --git a/site/content/docs/case_studies/index.md b/site/content/docs/case_studies/index.md
diff --git a/site/content/docs/community/index.md b/site/content/docs/community/index.md
diff --git a/site/content/docs/ecosystem/index.md b/site/content/docs/ecosystem/index.md
diff --git a/site/content/docs/glossary/bootstrapping.md b/site/content/docs/glossary/bootstrapping.md
diff --git a/site/content/docs/glossary/cardinality.md b/site/content/docs/glossary/cardinality.md
diff --git a/site/content/docs/glossary/datapoint.md b/site/content/docs/glossary/datapoint.md
diff --git a/site/content/docs/glossary/index.md b/site/content/docs/glossary/index.md
diff --git a/site/content/docs/glossary/labels.md b/site/content/docs/glossary/labels.md
diff --git a/site/content/docs/glossary/m3.md b/site/content/docs/glossary/m3.md
diff --git a/site/content/docs/glossary/m3coordinator.md b/site/content/docs/glossary/m3coordinator.md
diff --git a/site/content/docs/glossary/m3db.md b/site/content/docs/glossary/m3db.md
diff --git a/site/content/docs/glossary/m3query.md b/site/content/docs/glossary/m3query.md
diff --git a/site/content/docs/glossary/metric.md b/site/content/docs/glossary/metric.md
diff --git a/site/content/docs/glossary/namespace.md b/site/content/docs/glossary/namespace.md
diff --git a/site/content/docs/glossary/placement.md b/site/content/docs/glossary/placement.md