From b2bdff653a8c8aa28ca23c19665baf66355dd4b7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bartek=20P=C5=82otka?= Date: Tue, 16 Apr 2019 14:21:13 +0100 Subject: [PATCH] Fixed root docs and liche is now checking root dir as well. (#1040) Signed-off-by: Bartek Plotka --- CHANGELOG.md | 2 +- CONTRIBUTING.md | 2 +- Makefile | 1 + README.md | 2 +- 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 41d6a97a50..1ce8c27c1e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -175,7 +175,7 @@ Note lots of necessary breaking changes in flags that relates to bucket configur - In `thanos rule`, file based discovery of query nodes using `--query.file-sd-config.files` - In `thanos query`, file based discovery of store nodes using `--store.file-sd-config.files` - `/-/healthy` endpoint to Querier. -- DNS service discovery to static and file based configurations using the `dns+` and `dnssrv+` prefixes for the respective lookup. Details [here](/docs/service_discovery.md) +- DNS service discovery to static and file based configurations using the `dns+` and `dnssrv+` prefixes for the respective lookup. Details [here](docs/service-discovery.md) - `--cluster.disable` flag to disable gossip functionality completely. - Hidden flag to configure max compaction level. - Azure Storage. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6efb35b70f..4769428dd5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,7 +27,7 @@ Adding large new features and components to Thanos should be done by first creat ## Pull Request Process -1. Read [getting started docs](docs/getting_started.md) and prepare Thanos. +1. Read [getting started docs](docs/getting-started.md) and prepare Thanos. 2. Familiarize yourself with [Makefile](Makefile) commands like `format`, `build`, `proto` and `test`. 3. Fork improbable-eng/thanos.git and start development from your own fork. Here are sample steps to setup your development environment: ```console diff --git a/Makefile b/Makefile index f28581b57f..3b9394a8ee 100644 --- a/Makefile +++ b/Makefile @@ -139,6 +139,7 @@ docs: $(EMBEDMD) build check-docs: $(EMBEDMD) $(LICHE) build @EMBEDMD_BIN="$(EMBEDMD)" scripts/genflagdocs.sh check @$(LICHE) --recursive docs --exclude "cloud.tencent.com" --document-root . + @$(LICHE) --exclude "cloud.tencent.com" --document-root . *.md # errcheck performs static analysis and returns error if any of the errors is not checked. .PHONY: errcheck diff --git a/README.md b/README.md index a734ba329c..4ef66559f1 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Concretely the aims of the project are: ## Getting Started -* **[Getting Started](docs/getting_started.md)** +* **[Getting Started](docs/getting-started.md)** * [Design](docs/design.md) * [Prom Meetup Slides](https://www.slideshare.net/BartomiejPotka/thanos-global-durable-prometheus-monitoring) * [Introduction blog post](https://improbable.io/games/blog/thanos-prometheus-at-scale)