Skip to content
This repository was archived by the owner on Aug 23, 2023. It is now read-only.

Commit d7b6500

Browse files
authored
Merge pull request #1047 from grafana/refactor-docker-docs-a-bit
Refactor docker docs a bit
2 parents a62e7cc + ed6ae1e commit d7b6500

5 files changed

+13
-4
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ Otherwise data loss of current chunks will be incurred. See [operations guide](
5555

5656
* [Overview](https://github.com/grafana/metrictank/blob/master/docs/overview.md)
5757
* [Quick start using docker](https://github.com/grafana/metrictank/blob/master/docs/quick-start-docker.md)
58+
([other docker stacks](docs/docker.md))
5859
* [Installation guides](https://github.com/grafana/metrictank/blob/master/docs/installation.md)
5960
* [Configuration](https://github.com/grafana/metrictank/blob/master/docs/config.md)
6061
* [Memory server](https://github.com/grafana/metrictank/blob/master/docs/memory-server.md)

docs/CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,6 @@ see the [Makefile](../Makefile) for more targets
4444

4545
# Documentation
4646

47-
* [docs](../docs) for users and operators
48-
* [devdocs](../devdocs) for MT developers
47+
* [docs](../docs) for users, operators and basic development instructions
48+
* [devdocs](../devdocs) in-depth implementation details for developers
4949

devdocs/docker.md docs/docker.md

+4
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ plain, basic environment.
1717
uses metrictank docker image (with baked in binaries and configs), statsdaemon.
1818
Comes with 1 dashboard: the metrictank dashboard
1919

20+
[see our quickstart guide](https://github.com/grafana/metrictank/blob/master/docs/quick-start-docker.md)
21+
2022
### docker-dev
2123

2224
Similar to docker-standard, but custom metrictank build is loaded, custom configs from scripts/config
@@ -45,6 +47,8 @@ Similar to docker-dev-custom-cfg-kafka
4547
* uses a cluster of 4 MT's (with 2x replication)
4648
* separate graphite monitoring server
4749

50+
[see our docker-cluster quickstart guide](https://github.com/grafana/metrictank/blob/master/docs/quick-start-docker-cluster.md)
51+
4852
### docker-chaos
4953

5054
Similar to docker-cluster but used for chaos testing

docs/quick-start-docker-cluster.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Quick start for docker-cluster
22

3+
The metrictank repository holds various stack configurations. See [docker](docker.md) for more info.
4+
If you're not familiar with Grafana dashboarding and datasources, you should first follow
5+
[our standard quickstart guide](https://github.com/grafana/metrictank/blob/master/docs/quick-start-docker.md) which goes further in depth on that.
6+
37
The docker-cluster image is similar to docker-standard, but with the following changes and features:
48

59
* Cluster of 4 metrictanks (with 2x replication)
@@ -114,4 +118,4 @@ To clean up all data so you can start fresh, run this after you stopped the stac
114118
```
115119
docker rm -v $(docker ps -a -q -f status=exited)
116120
```
117-
This will remove the stopped containers and their data volumes.
121+
This will remove the stopped containers and their data volumes.

docs/quick-start-docker.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -171,4 +171,4 @@ This will remove the stopped containers and their data volumes.
171171

172172
## Other docker stacks
173173

174-
The metrictank repository holds other stack configurations as well (for clustering, benchmarking, etc). See [devdocs/docker](../devdocs/docker.md) for more info.
174+
The metrictank repository holds other stack configurations as well (for clustering, benchmarking, etc). See [docker](docker.md) for more info.

0 commit comments

Comments
 (0)