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 rebased #2899

Merged
merged 15 commits into from
Nov 16, 2020
Merged
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
42 changes: 35 additions & 7 deletions site/config.toml
Original file line number Diff line number Diff line change
@@ -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"
Expand All @@ -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"
Expand Down Expand Up @@ -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
Expand All @@ -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/"
Expand Down Expand Up @@ -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"]
Expand Down
42 changes: 42 additions & 0 deletions site/content/_index.md
Original file line number Diff line number Diff line change
@@ -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)
43 changes: 43 additions & 0 deletions site/content/docs.md
Original file line number Diff line number Diff line change
@@ -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)
1 change: 0 additions & 1 deletion site/content/docs/case_studies/index.md

This file was deleted.

13 changes: 0 additions & 13 deletions site/content/docs/community/index.md

This file was deleted.

1 change: 0 additions & 1 deletion site/content/docs/ecosystem/index.md

This file was deleted.

15 changes: 0 additions & 15 deletions site/content/docs/glossary/bootstrapping.md

This file was deleted.

15 changes: 0 additions & 15 deletions site/content/docs/glossary/cardinality.md

This file was deleted.

15 changes: 0 additions & 15 deletions site/content/docs/glossary/datapoint.md

This file was deleted.

12 changes: 0 additions & 12 deletions site/content/docs/glossary/index.md

This file was deleted.

16 changes: 0 additions & 16 deletions site/content/docs/glossary/labels.md

This file was deleted.

16 changes: 0 additions & 16 deletions site/content/docs/glossary/m3.md

This file was deleted.

15 changes: 0 additions & 15 deletions site/content/docs/glossary/m3coordinator.md

This file was deleted.

16 changes: 0 additions & 16 deletions site/content/docs/glossary/m3db.md

This file was deleted.

15 changes: 0 additions & 15 deletions site/content/docs/glossary/m3query.md

This file was deleted.

15 changes: 0 additions & 15 deletions site/content/docs/glossary/metric.md

This file was deleted.

13 changes: 0 additions & 13 deletions site/content/docs/glossary/namespace.md

This file was deleted.

14 changes: 0 additions & 14 deletions site/content/docs/glossary/placement.md

This file was deleted.

Loading