Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,16 @@ else
endif

# App lists (override on the command line: `make update-apps APPS="tenant redis"`)
APPS ?= tenant clickhouse foundationdb harbor redis mongodb openbao rabbitmq postgres nats kafka mariadb qdrant
APPS ?= tenant clickhouse foundationdb harbor redis mongodb openbao rabbitmq postgres nats kafka mariadb qdrant valkey opensearch bucket
K8S ?= kubernetes
K8S_NODES ?= kubernetes-nodes
VMS ?= vm-disk vm-instance
NETWORKING ?= vpc vpn http-cache tcp-balancer
SERVICES ?= bootbox etcd ingress monitoring seaweedfs
SERVICES += computeplane gateway
APPS_DEST_DIR ?= content/en/docs/$(DOC_VERSION)/applications
K8S_DEST_DIR ?= content/en/docs/$(DOC_VERSION)
K8S_NODES_DEST_DIR ?= content/en/docs/$(DOC_VERSION)/kubernetes
VMS_DEST_DIR ?= content/en/docs/$(DOC_VERSION)/virtualization
NETWORKING_DEST_DIR ?= content/en/docs/$(DOC_VERSION)/networking
SERVICES_DEST_DIR ?= content/en/docs/$(DOC_VERSION)/operations/services
Expand All @@ -99,6 +102,7 @@ update-networking:

update-k8s:
./hack/update_apps.sh --index --apps "$(K8S)" --dest "$(K8S_DEST_DIR)" --branch "$(FETCH_REF)" --source-ref "$(SOURCE_REF)"
./hack/update_apps.sh --apps "$(K8S_NODES)" --dest "$(K8S_NODES_DEST_DIR)" --branch "$(FETCH_REF)" --source-ref "$(SOURCE_REF)"

update-services:
./hack/update_apps.sh --apps "$(SERVICES)" --dest "$(SERVICES_DEST_DIR)" --branch "$(FETCH_REF)" --source-ref "$(SOURCE_REF)" --pkgdir extra
Expand Down Expand Up @@ -186,6 +190,7 @@ template-networking:
./hack/fill_templates.sh --apps "$(NETWORKING)" --dest "$(NETWORKING_DEST_DIR)" --branch "$(BRANCH)"
template-k8s:
./hack/fill_templates.sh --apps "$(K8S)" --dest "$(K8S_DEST_DIR)" --branch "$(BRANCH)"
./hack/fill_templates.sh --apps "$(K8S_NODES)" --dest "$(K8S_NODES_DEST_DIR)" --branch "$(BRANCH)"

template-services:
./hack/fill_templates.sh --apps "$(SERVICES)" --dest "$(SERVICES_DEST_DIR)" --branch "$(BRANCH)" --pkgdir extra
Expand Down
6 changes: 6 additions & 0 deletions content/en/docs/next/applications/_include/bucket.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "S3 Bucket Reference"
linkTitle: "Bucket"
weight: 50
---

6 changes: 6 additions & 0 deletions content/en/docs/next/applications/_include/opensearch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Managed OpenSearch Service"
linkTitle: "OpenSearch"
weight: 50
---

6 changes: 6 additions & 0 deletions content/en/docs/next/applications/_include/valkey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Managed Valkey Service"
linkTitle: "Valkey"
weight: 50
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Kubernetes Worker Node Pools"
linkTitle: "Worker Node Pools"
description: "Reference for KubernetesNodes, the resource that adds a pool of worker nodes to a managed Kubernetes cluster."
weight: 10
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "ComputePlane Service Reference"
linkTitle: "ComputePlane"
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Tenant Gateway Reference"
linkTitle: "Gateway"
---

16 changes: 12 additions & 4 deletions hack/update_apps.sh
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Options:
Notes:
* Template markdown files are expected in DEST_DIR/_include (derived automatically).
* Each template file should be named <app>.md.
* An app without a template is skipped with a warning: the templates decide which apps
that docs version covers.

Examples:
hack/update_apps.sh --apps "tenant redis" --dest content/en/docs/reference/applications
Expand Down Expand Up @@ -84,7 +86,7 @@ RAW_BASE_URL="https://raw.githubusercontent.com/${SOURCE_REPO}/${BRANCH}/package


# The per-app temp file is removed on every explicit exit path below; the trap
# covers aborts between mktemp and those paths (set -e on touch/cp/heredoc).
# covers aborts between mktemp and those paths (set -e on cp/heredoc).
trap 'rm -f "${tmp:-}"' EXIT

for app in "${APPS[@]}"; do
Expand All @@ -101,6 +103,15 @@ for app in "${APPS[@]}"; do
fi
fi

# A patch release of an older line runs these same lists against a tree and a tag
# that predate newer apps, whose README may 404 at that tag. Such a tree has no
# template for them, so skip the app instead of fetching it or writing a page
# without front matter.
if [[ ! -f "$src_file" ]]; then
echo "⚠️ Skipping $app: no template $src_file in this docs version" >&2
continue
fi

readme_url="${RAW_BASE_URL}/${app}/README.md"
echo "Processing $app..."

Expand All @@ -119,9 +130,6 @@ for app in "${APPS[@]}"; do
exit 1
fi

# Ensure template exists (touch if missing)
[[ -f "$src_file" ]] || touch "$src_file"

# Copy template to destination (overwrite)
cp "$src_file" "$dest_file"

Expand Down
Loading