Skip to content

Commit 528b321

Browse files
authored
📖 fix broken catalod api reference link (#2152)
* (docs) fix broken catalod api reference link The make target `crd-ref-docs` generates the api reference doc operator-controller-api-reference.md using the API types in the `api/` directory. The docs structure was expecting two files, while only one file was being generated. This PR fixes the doc structure to expect only one file, getting rid of a broken link as a result. * rename api ref doc to olmv1-api-reference
1 parent 1c7286f commit 528b321

File tree

4 files changed

+3
-5
lines changed

4 files changed

+3
-5
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -464,7 +464,7 @@ quickstart: manifests #EXHELP Generate the unified installation release manifest
464464
##@ Docs
465465

466466
.PHONY: crd-ref-docs
467-
API_REFERENCE_FILENAME := operator-controller-api-reference.md
467+
API_REFERENCE_FILENAME := olmv1-api-reference.md
468468
API_REFERENCE_DIR := $(ROOT_DIR)/docs/api-reference
469469
crd-ref-docs: $(CRD_REF_DOCS) #EXHELP Generate the API Reference Documents.
470470
rm -f $(API_REFERENCE_DIR)/$(API_REFERENCE_FILENAME)
File renamed without changes.

docs/project/public-api.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
The public API of OLM v1 is as follows:
33

44
- Kubernetes APIs. For more information on these APIs, see:
5-
- [operator-controller API reference](../api-reference/operator-controller-api-reference.md)
6-
- [catalogd API reference](../api-reference/catalogd-api-reference.md)
5+
- [OLMv1 API reference](../api-reference/olmv1-api-reference.md)
76
- `Catalogd` web server. For more information on what this includes, see the [catalogd web server documentation](../api-reference/catalogd-webserver.md)
87

98
!!! warning

mkdocs.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,7 @@ nav:
4949
- Content Resolution: concepts/controlling-catalog-selection.md
5050
- Version Ranges: concepts/version-ranges.md
5151
- API Reference:
52-
- Operator Controller API reference: api-reference/operator-controller-api-reference.md
53-
- CatalogD API reference: api-reference/catalogd-api-reference.md
52+
- OLMv1 API reference: api-reference/olmv1-api-reference.md
5453
- CatalogD Web Server reference: api-reference/catalogd-webserver.md
5554
- Contribute:
5655
- Contributing: contribute/contributing.md

0 commit comments

Comments
 (0)