From 26526735cda2f3715f93471609671cf046b76942 Mon Sep 17 00:00:00 2001 From: Anik Bhattacharjee Date: Tue, 19 Aug 2025 14:02:43 -0400 Subject: [PATCH 1/2] (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. --- docs/project/public-api.md | 1 - mkdocs.yml | 1 - 2 files changed, 2 deletions(-) diff --git a/docs/project/public-api.md b/docs/project/public-api.md index a0e45ce93..8930f9a21 100644 --- a/docs/project/public-api.md +++ b/docs/project/public-api.md @@ -3,7 +3,6 @@ The public API of OLM v1 is as follows: - Kubernetes APIs. For more information on these APIs, see: - [operator-controller API reference](../api-reference/operator-controller-api-reference.md) - - [catalogd API reference](../api-reference/catalogd-api-reference.md) - `Catalogd` web server. For more information on what this includes, see the [catalogd web server documentation](../api-reference/catalogd-webserver.md) !!! warning diff --git a/mkdocs.yml b/mkdocs.yml index f7b20ae07..c70be6aeb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -50,7 +50,6 @@ nav: - Version Ranges: concepts/version-ranges.md - API Reference: - Operator Controller API reference: api-reference/operator-controller-api-reference.md - - CatalogD API reference: api-reference/catalogd-api-reference.md - CatalogD Web Server reference: api-reference/catalogd-webserver.md - Contribute: - Contributing: contribute/contributing.md From 0979e4da724fd3a626b0f5ec6d183c63b62fe45a Mon Sep 17 00:00:00 2001 From: Anik Bhattacharjee Date: Tue, 19 Aug 2025 14:18:00 -0400 Subject: [PATCH 2/2] rename api ref doc to olmv1-api-reference --- Makefile | 2 +- ...rator-controller-api-reference.md => olmv1-api-reference.md} | 0 docs/project/public-api.md | 2 +- mkdocs.yml | 2 +- 4 files changed, 3 insertions(+), 3 deletions(-) rename docs/api-reference/{operator-controller-api-reference.md => olmv1-api-reference.md} (100%) diff --git a/Makefile b/Makefile index a578d11d5..eaf62f2af 100644 --- a/Makefile +++ b/Makefile @@ -464,7 +464,7 @@ quickstart: manifests #EXHELP Generate the unified installation release manifest ##@ Docs .PHONY: crd-ref-docs -API_REFERENCE_FILENAME := operator-controller-api-reference.md +API_REFERENCE_FILENAME := olmv1-api-reference.md API_REFERENCE_DIR := $(ROOT_DIR)/docs/api-reference crd-ref-docs: $(CRD_REF_DOCS) #EXHELP Generate the API Reference Documents. rm -f $(API_REFERENCE_DIR)/$(API_REFERENCE_FILENAME) diff --git a/docs/api-reference/operator-controller-api-reference.md b/docs/api-reference/olmv1-api-reference.md similarity index 100% rename from docs/api-reference/operator-controller-api-reference.md rename to docs/api-reference/olmv1-api-reference.md diff --git a/docs/project/public-api.md b/docs/project/public-api.md index 8930f9a21..687c14a2a 100644 --- a/docs/project/public-api.md +++ b/docs/project/public-api.md @@ -2,7 +2,7 @@ The public API of OLM v1 is as follows: - Kubernetes APIs. For more information on these APIs, see: - - [operator-controller API reference](../api-reference/operator-controller-api-reference.md) + - [OLMv1 API reference](../api-reference/olmv1-api-reference.md) - `Catalogd` web server. For more information on what this includes, see the [catalogd web server documentation](../api-reference/catalogd-webserver.md) !!! warning diff --git a/mkdocs.yml b/mkdocs.yml index c70be6aeb..e89189622 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -49,7 +49,7 @@ nav: - Content Resolution: concepts/controlling-catalog-selection.md - Version Ranges: concepts/version-ranges.md - API Reference: - - Operator Controller API reference: api-reference/operator-controller-api-reference.md + - OLMv1 API reference: api-reference/olmv1-api-reference.md - CatalogD Web Server reference: api-reference/catalogd-webserver.md - Contribute: - Contributing: contribute/contributing.md