Skip to content

Commit 58d136a

Browse files
authored
Add index entries for API Reference (gardener#4986)
* Add index entries for API Reference * Fix check-generate
1 parent bf03264 commit 58d136a

File tree

3 files changed

+20
-1
lines changed

3 files changed

+20
-1
lines changed

docs/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,16 @@
5858
* [Troubleshooting guide](usage/trouble_shooting_guide.md)
5959
* [Trusted TLS certificate for shoot control planes](usage/trusted-tls-for-control-planes.md)
6060

61+
## [API Reference](api-reference/README.md)
62+
63+
* [`authentication.gardener.cloud` API Group](api-reference/authentication.md)
64+
* [`core.gardener.cloud` API Group](api-reference/core.md)
65+
* [`extensions.gardener.cloud` API Group](api-reference/extensions.md)
66+
* [`operations.gardener.cloud` API Group](api-reference/operations.md)
67+
* [`resources.gardener.cloud` API Group](api-reference/resources.md)
68+
* [`seedmanagement.gardener.cloud` API Group](api-reference/seedmanagement.md)
69+
* [`settings.gardener.cloud` API Group](api-reference/settings.md)
70+
6171
## Proposals
6272

6373
* [GEP: Gardener Enhancement Proposal Description](proposals/README.md)

docs/api-reference/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Gardener API Reference
2+
3+
* [`authentication.gardener.cloud` API Group](authentication.md)
4+
* [`core.gardener.cloud` API Group](core.md)
5+
* [`extensions.gardener.cloud` API Group](extensions.md)
6+
* [`operations.gardener.cloud` API Group](operations.md)
7+
* [`resources.gardener.cloud` API Group](resources.md)
8+
* [`seedmanagement.gardener.cloud` API Group](seedmanagement.md)
9+
* [`settings.gardener.cloud` API Group](settings.md)

hack/clean.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,5 @@ for source_tree in $@; do
3030
done
3131

3232
if [ -d "$PWD/docs/api-reference" ]; then
33-
find ./docs/api-reference/ -type f -name "*.md" -exec rm '{}' \;
33+
find ./docs/api-reference/ -type f -name "*.md" ! -name "README.md" -exec rm '{}' \;
3434
fi

0 commit comments

Comments
 (0)