Skip to content

Commit 3f22eff

Browse files
committed
docs: rename the Documentation folder to docs
1 parent 2a5b7e0 commit 3f22eff

25 files changed

+4
-4
lines changed

Makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ format: shellcheck
2929
./tests/check_license.sh
3030

3131
doccheck:
32-
@echo "- Checking if documentation is up to date..."
33-
@grep -hoE '(kube_[^ |]+)' Documentation/* --exclude=README.md| sort -u > documented_metrics
32+
@echo "- Checking if the documentation is up to date..."
33+
@grep -hoE '(kube_[^ |]+)' docs/* --exclude=README.md| sort -u > documented_metrics
3434
@sed -n 's/.*# TYPE \(kube_[^ ]\+\).*/\1/p' internal/collector/*_test.go | sort -u > tested_metrics
3535
@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)
3636
@echo OK
3737
@rm -f tested_metrics documented_metrics
3838
@echo "- Checking for orphan documentation files"
39-
@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
39+
@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
4040
@echo OK
4141

4242
build-local: clean

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ additional metrics!
9999
> Any collectors and metrics based on alpha Kubernetes APIs are excluded from any stability guarantee,
100100
> which may be changed at any given release.
101101
102-
See the [`Documentation`](Documentation) directory for more information on the exposed metrics.
102+
See the [`docs`](docs) directory for more information on the exposed metrics.
103103

104104
### Kube-state-metrics self metrics
105105
kube-state-metrics exposes its own general process metrics under `--telemetry-host` and `--telemetry-port` (default 81).
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)