Skip to content

Commit

Permalink
Add index entries for API Reference (gardener#4986)
Browse files Browse the repository at this point in the history
* Add index entries for API Reference

* Fix check-generate
  • Loading branch information
timebertt authored Nov 10, 2021
1 parent bf03264 commit 58d136a
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 1 deletion.
10 changes: 10 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,16 @@
* [Troubleshooting guide](usage/trouble_shooting_guide.md)
* [Trusted TLS certificate for shoot control planes](usage/trusted-tls-for-control-planes.md)

## [API Reference](api-reference/README.md)

* [`authentication.gardener.cloud` API Group](api-reference/authentication.md)
* [`core.gardener.cloud` API Group](api-reference/core.md)
* [`extensions.gardener.cloud` API Group](api-reference/extensions.md)
* [`operations.gardener.cloud` API Group](api-reference/operations.md)
* [`resources.gardener.cloud` API Group](api-reference/resources.md)
* [`seedmanagement.gardener.cloud` API Group](api-reference/seedmanagement.md)
* [`settings.gardener.cloud` API Group](api-reference/settings.md)

## Proposals

* [GEP: Gardener Enhancement Proposal Description](proposals/README.md)
Expand Down
9 changes: 9 additions & 0 deletions docs/api-reference/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Gardener API Reference

* [`authentication.gardener.cloud` API Group](authentication.md)
* [`core.gardener.cloud` API Group](core.md)
* [`extensions.gardener.cloud` API Group](extensions.md)
* [`operations.gardener.cloud` API Group](operations.md)
* [`resources.gardener.cloud` API Group](resources.md)
* [`seedmanagement.gardener.cloud` API Group](seedmanagement.md)
* [`settings.gardener.cloud` API Group](settings.md)
2 changes: 1 addition & 1 deletion hack/clean.sh
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ for source_tree in $@; do
done

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

0 comments on commit 58d136a

Please sign in to comment.