[Docs] Update References (#1812)

Author: ajanikow

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## [master](https://github.com/arangodb/kube-arangodb/tree/master) (N/A)
 - (Feature) (Platform) Inventory as Proto
+- (Docs) Update Refs
 
 ## [1.2.44](https://github.com/arangodb/kube-arangodb/tree/1.2.44) (2025-02-03)
 - (Maintenance) Kubernetes 1.31.1 libraries

Makefile

@@ -281,6 +281,12 @@ YAML_EXCLUDE_FILES :=
 YAML_QUERY := find ./ -type f -name '*.yaml' $(foreach EXCLUDE_DIR,$(YAML_EXCLUDE_DIRS), ! -path "*/$(EXCLUDE_DIR)/*") $(foreach EXCLUDE_FILE,$(YAML_EXCLUDE_FILES), ! -path "*/$(EXCLUDE_FILE)")
 YAMLS := $(shell $(YAML_QUERY))
 
+
+DOCS_EXCLUDE_DIRS := 
+DOCS_EXCLUDE_FILES :=
+DOCS_QUERY := find ./docs/ -type f -name '*.md' $(foreach EXCLUDE_DIR,$(DOCS_EXCLUDE_DIRS), ! -path "*/$(EXCLUDE_DIR)/*") $(foreach EXCLUDE_FILE,$(DOCS_EXCLUDE_FILES), ! -path "*/$(EXCLUDE_FILE)")
+DOCS := $(shell $(DOCS_QUERY))
+
 DASHBOARDSOURCES := $(shell find $(DASHBOARDDIR)/src -name '*.js') $(DASHBOARDDIR)/package.json
 LINT_EXCLUDES:=
 ifeq ($(RELEASE_MODE),enterprise)
@@ -745,18 +751,22 @@ run-unit-tests: $(SOURCES)
 
 .PHONY: patch-readme
 patch-readme:
-	$(ROOTDIR)/scripts/patch_readme.sh $(VERSION_MAJOR_MINOR_PATCH)
+	@$(ROOTDIR)/scripts/patch_readme.sh $(VERSION_MAJOR_MINOR_PATCH)
 
 .PHONY: patch-examples
 patch-examples:
-	$(ROOTDIR)/scripts/patch_examples.sh $(VERSION_MAJOR_MINOR_PATCH)
+	@$(ROOTDIR)/scripts/patch_examples.sh $(VERSION_MAJOR_MINOR_PATCH)
+
+.PHONY: patch-docs
+patch-docs:
+	@$(ROOTDIR)/scripts/patch_docs.sh $(VERSION_MAJOR_MINOR_PATCH) $(DOCS)
 
 .PHONY: patch-release
 patch-release: patch-readme patch-examples patch-chart
 
 .PHONY: patch-chart
 patch-chart:
-	$(ROOTDIR)/scripts/patch_chart.sh $(VERSION_MAJOR_MINOR_PATCH)
+	@$(ROOTDIR)/scripts/patch_chart.sh $(VERSION_MAJOR_MINOR_PATCH)
 
 .PHONY: patch
 patch: patch-chart patch-release patch-examples patch-readme
@@ -955,6 +965,6 @@ sync-charts:
 sync: sync-charts
 
 ci-check:
-	@$(MAKE) tidy vendor generate update-generated synchronize-v2alpha1-with-v1 sync fmt yamlfmt license protolint
+	@$(MAKE) tidy vendor patch generate update-generated synchronize-v2alpha1-with-v1 sync fmt yamlfmt license protolint
 	@git checkout -- go.sum # ignore changes in go.sum
 	@if [ ! -z "$$(git status --porcelain)" ]; then echo "There are uncommited changes!"; git status; exit 1; fi

docs/integration-sidecar.md

@@ -119,7 +119,7 @@ metadata:
     integration.profiles.arangodb.com/<< integration name >>: << integration version >>
 ```
 
-#### [Authentication V1](/docs/integration/authentication.v1.md)
+#### [Authentication V1](./integration/authentication.v1.md)
 
 Authentication Integration Sidecar
 
@@ -131,7 +131,7 @@ metadata:
     integration.profiles.arangodb.com/authn: v1
 ```
 
-#### [Authorization V0](/docs/integration/authorization.v0.md)
+#### [Authorization V0](./integration/authorization.v0.md)
 
 Authorization Integration Sidecar
 
@@ -143,7 +143,7 @@ metadata:
     integration.profiles.arangodb.com/authz: v0
 ```
 
-#### [Scheduler V2](/docs/integration/scheduler.v2.md)
+#### [Scheduler V2](./integration/scheduler.v2.md)
 
 Scheduler Integration Sidecar
 
@@ -155,7 +155,19 @@ metadata:
     integration.profiles.arangodb.com/sched: v2
 ```
 
-#### [Storage V2](/docs/integration/storage.v2.md)
+#### [Storage V1](./integration/storage.v1.md)
+
+Storage Integration Sidecar (legacy)
+
+To enable:
+
+```yaml
+metadata:
+  labels:
+    integration.profiles.arangodb.com/storage: v1
+```
+
+#### [Storage V2](./integration/storage.v2.md)
 
 Storage Integration Sidecar
 
@@ -167,7 +179,7 @@ metadata:
     integration.profiles.arangodb.com/storage: v2
 ```
 
-#### [Shutdown V1](/docs/integration/shutdown.v1.md)
+#### [Shutdown V1](./integration/shutdown.v1.md)
 
 Shutdown Integration Sidecar
 

docs/integration/authentication.v1.md

@@ -1,11 +1,11 @@
 ---
 layout: page
 title: Authentication V1
-parent: ArangoDBPlatform
+parent: Integration Sidecars
 ---
 
 # Authentication V1
 
 Definitions:
 
-- [Service](../../integrations/authentication/v1/definition/definition.proto)
+- [Service](https://github.com/arangodb/kube-arangodb/blob/1.2.44/integrations/authentication/v1/definition/definition.proto)

docs/integration/authorization.v0.md

@@ -1,12 +1,12 @@
 ---
 layout: page
-title: Authentication V1
-parent: ArangoDBPlatform
+title: Authorization V0
+parent: Integration Sidecars
 ---
 
 # Authorization V0
 
 Definitions:
 
-- [Service](../../integrations/authorization/v0/definition/definition.proto)
+- [Service](https://github.com/arangodb/kube-arangodb/blob/1.2.44/integrations/authorization/v0/definition/definition.proto)
 

docs/integration/scheduler.v1.md

@@ -0,0 +1,12 @@
+---
+layout: page
+title: Scheduler V1
+parent: Integration Sidecars
+---
+
+# Scheduler V1
+
+Definitions:
+
+- [Service](https://github.com/arangodb/kube-arangodb/blob/1.2.44/integrations/scheduler/v1/definition/definition.proto)
+

docs/integration/scheduler.v2.md

@@ -1,12 +1,12 @@
 ---
 layout: page
-title: Authentication V1
-parent: ArangoDBPlatform
+title: Scheduler V2
+parent: Integration Sidecars
 ---
 
 # Scheduler V2
 
 Definitions:
 
-- [Service](../../integrations/scheduler/v2/definition/definition.proto)
+- [Service](https://github.com/arangodb/kube-arangodb/blob/1.2.44/integrations/scheduler/v2/definition/definition.proto)
 

docs/integration/shutdown.v1.md

@@ -1,14 +1,14 @@
 ---
 layout: page
-title: Authentication V1
-parent: ArangoDBPlatform
+title: Shutdown V1
+parent: Integration Sidecars
 ---
 
 # Shutdown V1
 
 Definitions:
 
-- [Service](../../integrations/shutdown/v1/definition/definition.proto)
+- [Service](https://github.com/arangodb/kube-arangodb/blob/1.2.44/integrations/shutdown/v1/definition/shutdown.proto)
 
 Operator will send shutdown request once all containers marked with annotation are stopped.
 

docs/integration/storage.v2.md

@@ -1,12 +1,12 @@
 ---
 layout: page
-title: Authentication V1
-parent: ArangoDBPlatform
+title: Storage V2
+parent: Integration Sidecars
 ---
 
 # Storage V2
 
 Definitions:
 
-- [Service](./definition.proto)
+- [Service](https://github.com/arangodb/kube-arangodb/blob/1.2.44/integrations/storage/v2/definition/storage.proto)
 

scripts/patch_docs.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+# Updates the installation instructions in README.md to reflect the current 
+# version.
+
+VERSION=$1
+
+if [ -z $VERSION ]; then
+    echo "Specify a version argument"
+    exit 1
+fi
+
+function replaceInFile {
+    local EXPR=$1
+    local FILE=$2
+    sed -E -i --expression "${EXPR}" ${FILE}
+}
+
+
+shift 1
+
+for f in "$@"; do
+  replaceInFile "s@https://github.com/arangodb/kube-arangodb/blob/[0-9]+\.[0-9]+\.[0-9]+/@https://github.com/arangodb/kube-arangodb/blob/${VERSION}/@g" ${f}
+done