[DOCS] Quickstart revamp (#2541)

Revamp quickstart guide

netlify.toml

@@ -10,7 +10,7 @@
   publish = "/site/public/"
 
   command = "make site-build -C ../"  
-  HUGO_VERSION = "0.75.1"
+  HUGO_VERSION = "0.76.5"
 
 [[redirects]]
   from = "/misc/writing_docs/"
@@ -28,7 +28,11 @@
   from = "https://docs.m3db.io/*"
   to = "https://m3db.io/docs/:splat"
 
+[[redirects]]
+  from = "/docs/how_to/single_node"
+  to = "docs/quickstart"
+
 # TODO: Fix this with new content type
 [[redirects]]
   from = "/talks"
-  to = "docs/overview/media"
+  to = "docs/overview/media"

site/config.toml

@@ -117,7 +117,11 @@ offlineSearch = false
   themeVariant = "blue"
   twitter = "m3db_io"
 
-# TODO: Might need to refactor some of the K8s shortcodes later
+  [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]]

site/content/docs/_index.md

@@ -27,7 +27,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/how_to/single_node)
+-   [Single M3DB node deployment](/docs/quickstart)
 -   [Clustered M3DB deployment](/docs/how_to/cluster_hard_way)
 -   [M3DB on Kubernetes](/docs/how_to/kubernetes)
 -   [Isolated M3Query on deployment](/docs/how_to/query)

site/content/docs/glossary/namespace.md

@@ -3,14 +3,11 @@ title: Namespace
 id: namespace
 date: 2019-06-15
 full_link: 
-short_description: >
-   I am a test term.
-
+short_description: Configuration for a set of data
 aka: 
 tags:
-- example
-- illustration
+- table
+- configuration
 ---
 
-Similar to a table in other types of databases, namespaces in M3DB have a unique name and a set of configuration options, such as data retention and block size.
-
+Similar to a table in other types of databases, namespaces in M3DB have a unique name and a set of configuration options, such as data retention and block size.

site/content/docs/glossary/placement.md

@@ -3,15 +3,12 @@ title: Placement
 id: placement
 date: 2019-06-15
 full_link: 
-short_description: >
-   I am a test term.
-
-aka: 
+short_description: Map of cluster shard replicas to nodes
+aka:
+- topology
 tags:
-- example
-- illustration
+- topology
+- shards
 ---
 
-Map of the M3DB cluster's shard replicas to nodes. Each M3DB cluster has only one placement. Placement and Topology are interchangeable terms.
-
-
+Map of the M3DB cluster's shard replicas to nodes. Each M3DB cluster has only one placement. Placement and Topology are interchangeable terms.

site/content/docs/glossary/shard.md

@@ -3,9 +3,7 @@ title: Shard
 id: shard
 date: 2019-06-15
 full_link: 
-short_description: >
-   I am a test term.
-
+short_description: Distribution of time series data
 aka: 
 tags:
 - example

site/content/docs/how_to/aggregator.md

@@ -14,7 +14,7 @@ Similar to M3DB, `m3aggregator` supports clustering and replication by default.
 
 ## Configuration
 
-Before setting up m3aggregator, make sure that you have at least [one M3DB node running](/docs/how_to/single_node) and a dedicated m3coordinator setup.
+Before setting up m3aggregator, make sure that you have at least [one M3DB node running](/docs/quickstart) and a dedicated m3coordinator setup.
 
 We highly recommend running with at least a replication factor 2 for a `m3aggregator` deployment. If you run with replication factor 1 then when you restart an aggregator it will temporarily interrupt good the stream of aggregated metrics and there will be some data loss.
 

site/content/docs/how_to/query.md

@@ -9,7 +9,7 @@ m3query is used to query data that is stored in M3DB. For instance, if you are u
 
 ## Configuration
 
-Before setting up m3query, make sure that you have at least [one M3DB node running](/docs/how_to/single_node). In order to start m3query, you need to configure a `yaml` file, that will be used to connect to M3DB. Here is a link to a [sample config](https://github.com/m3db/m3/blob/master/src/query/config/m3query-local-etcd.yml) file that is used for an embedded etcd cluster within M3DB.
+Before setting up m3query, make sure that you have at least [one M3DB node running](/docs/quickstart). In order to start m3query, you need to configure a `yaml` file, that will be used to connect to M3DB. Here is a link to a [sample config](https://github.com/m3db/m3/blob/master/src/query/config/m3query-local-etcd.yml) file that is used for an embedded etcd cluster within M3DB.
 
 ### Running
 
@@ -24,7 +24,7 @@ Or you can run it with Docker using the Docker file located at `$GOPATH/src/gith
 
 ### Namespaces
 
-All namespaces that you wish to query from must be configured when [setting up M3DB](/docs/how_to/single_node). If you wish to add or change an existing namespace, please follow the namespace operational guide [here](/docs/operational_guide/namespace_configuration).
+All namespaces that you wish to query from must be configured when [setting up M3DB](/docs/quickstart). If you wish to add or change an existing namespace, please follow the namespace operational guide [here](/docs/operational_guide/namespace_configuration).
 
 ### etcd
 

site/content/docs/includes/quickstart/create-database.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+curl -X POST http://localhost:7201/api/v1/database/create -d '{
+  "type": "local",
+  "namespaceName": "default",
+  "retentionTime": "12h"
+}' | jq .

site/content/docs/includes/quickstart/write-metrics-1.sh

@@ -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
+}'

site/content/docs/includes/quickstart/write-metrics-2.sh

@@ -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
+}'

site/content/docs/includes/quickstart/write-metrics-3.sh

@@ -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
+}'

site/content/docs/integrations/graphite.md

@@ -11,7 +11,7 @@ M3 supports ingesting Graphite metrics using the [Carbon plaintext protocol](htt
 
 ## Ingestion
 
-Setting up the M3 stack to ingest carbon metrics is straightforward. First, make sure you've followed our [other documentation](/docs/how_to/single_node) to get m3coordinator and M3DB setup. Also, familiarize yourself with how M3 [handles aggregation](/docs/how_to/query).
+Setting up the M3 stack to ingest carbon metrics is straightforward. First, make sure you've followed our [other documentation](/docs/quickstart) to get m3coordinator and M3DB setup. Also, familiarize yourself with how M3 [handles aggregation](/docs/how_to/query).
 
 Once you have both of those services running properly, modify your m3coordinator configuration to add the following lines and restart it: