docs: rename the Documentation folder to docs

olivierlemasle · Feb 20, 2019 · 3f22eff · 3f22eff
1 parent 2a5b7e0
commit 3f22eff
Show file tree

Hide file tree

Showing 25 changed files with 4 additions and 4 deletions.
diff --git a/Makefile b/Makefile
@@ -29,14 +29,14 @@ format: shellcheck
 	./tests/check_license.sh
 
 doccheck:
-	@echo "- Checking if documentation is up to date..."
-	@grep -hoE '(kube_[^ |]+)' Documentation/* --exclude=README.md| sort -u > documented_metrics
+	@echo "- Checking if the documentation is up to date..."
+	@grep -hoE '(kube_[^ |]+)' docs/* --exclude=README.md| sort -u > documented_metrics
 	@sed -n 's/.*# TYPE \(kube_[^ ]\+\).*/\1/p' internal/collector/*_test.go | sort -u > tested_metrics
 	@diff -u0 tested_metrics documented_metrics || (echo "ERROR: Metrics with - are present in tests but missing in documentation, metrics with + are documented but not tested."; exit 1)
 	@echo OK
 	@rm -f tested_metrics documented_metrics
 	@echo "- Checking for orphan documentation files"
-	@cd Documentation; for doc in *.md; do if [ "$$doc" != "README.md" ] && ! grep -q "$$doc" *.md; then echo "ERROR: No link to documentation file $${doc} detected"; exit 1; fi; done
+	@cd docs; for doc in *.md; do if [ "$$doc" != "README.md" ] && ! grep -q "$$doc" *.md; then echo "ERROR: No link to documentation file $${doc} detected"; exit 1; fi; done
 	@echo OK
 
 build-local: clean

diff --git a/README.md b/README.md
@@ -99,7 +99,7 @@ additional metrics!
 > Any collectors and metrics based on alpha Kubernetes APIs are excluded from any stability guarantee,
 > which may be changed at any given release.
 
-See the [`Documentation`](Documentation) directory for more information on the exposed metrics.
+See the [`docs`](docs) directory for more information on the exposed metrics.
 
 ### Kube-state-metrics self metrics
 kube-state-metrics exposes its own general process metrics under `--telemetry-host` and `--telemetry-port` (default 81).

diff --git a/Documentation/README.md → docs/README.md b/Documentation/README.md → docs/README.md
diff --git a/Documentation/configmap-metrics.md → docs/configmap-metrics.md b/Documentation/configmap-metrics.md → docs/configmap-metrics.md
diff --git a/Documentation/cronjob-metrics.md → docs/cronjob-metrics.md b/Documentation/cronjob-metrics.md → docs/cronjob-metrics.md
diff --git a/Documentation/daemonset-metrics.md → docs/daemonset-metrics.md b/Documentation/daemonset-metrics.md → docs/daemonset-metrics.md
diff --git a/Documentation/deployment-metrics.md → docs/deployment-metrics.md b/Documentation/deployment-metrics.md → docs/deployment-metrics.md
diff --git a/...metrics-store-performance-optimization.md → ...metrics-store-performance-optimization.md b/...metrics-store-performance-optimization.md → ...metrics-store-performance-optimization.md
diff --git a/Documentation/endpoint-metrics.md → docs/endpoint-metrics.md b/Documentation/endpoint-metrics.md → docs/endpoint-metrics.md
diff --git a/...tation/horizontalpodautoscaler-metrics.md → docs/horizontalpodautoscaler-metrics.md b/...tation/horizontalpodautoscaler-metrics.md → docs/horizontalpodautoscaler-metrics.md
diff --git a/Documentation/ingress-metrics.md → docs/ingress-metrics.md b/Documentation/ingress-metrics.md → docs/ingress-metrics.md
diff --git a/Documentation/job-metrics.md → docs/job-metrics.md b/Documentation/job-metrics.md → docs/job-metrics.md
diff --git a/Documentation/limitrange-metrics.md → docs/limitrange-metrics.md b/Documentation/limitrange-metrics.md → docs/limitrange-metrics.md
diff --git a/Documentation/namespace-metrics.md → docs/namespace-metrics.md b/Documentation/namespace-metrics.md → docs/namespace-metrics.md
diff --git a/Documentation/node-metrics.md → docs/node-metrics.md b/Documentation/node-metrics.md → docs/node-metrics.md
diff --git a/Documentation/persistentvolume-metrics.md → docs/persistentvolume-metrics.md b/Documentation/persistentvolume-metrics.md → docs/persistentvolume-metrics.md
diff --git a/...entation/persistentvolumeclaim-metrics.md → docs/persistentvolumeclaim-metrics.md b/...entation/persistentvolumeclaim-metrics.md → docs/persistentvolumeclaim-metrics.md
diff --git a/Documentation/pod-metrics.md → docs/pod-metrics.md b/Documentation/pod-metrics.md → docs/pod-metrics.md
diff --git a/Documentation/poddisruptionbudget-metrics.md → docs/poddisruptionbudget-metrics.md b/Documentation/poddisruptionbudget-metrics.md → docs/poddisruptionbudget-metrics.md
diff --git a/Documentation/replicaset-metrics.md → docs/replicaset-metrics.md b/Documentation/replicaset-metrics.md → docs/replicaset-metrics.md
diff --git a/...entation/replicationcontroller-metrics.md → docs/replicationcontroller-metrics.md b/...entation/replicationcontroller-metrics.md → docs/replicationcontroller-metrics.md
diff --git a/Documentation/resourcequota-metrics.md → docs/resourcequota-metrics.md b/Documentation/resourcequota-metrics.md → docs/resourcequota-metrics.md
diff --git a/Documentation/secret-metrics.md → docs/secret-metrics.md b/Documentation/secret-metrics.md → docs/secret-metrics.md
diff --git a/Documentation/service-metrics.md → docs/service-metrics.md b/Documentation/service-metrics.md → docs/service-metrics.md
diff --git a/Documentation/statefulset-metrics.md → docs/statefulset-metrics.md b/Documentation/statefulset-metrics.md → docs/statefulset-metrics.md