diff --git a/Makefile b/Makefile index 7847b2447..6bf3d05d8 100644 --- a/Makefile +++ b/Makefile @@ -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 @@ -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 @@ -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 diff --git a/content/en/docs/next/applications/_include/bucket.md b/content/en/docs/next/applications/_include/bucket.md new file mode 100644 index 000000000..a51130023 --- /dev/null +++ b/content/en/docs/next/applications/_include/bucket.md @@ -0,0 +1,6 @@ +--- +title: "S3 Bucket Reference" +linkTitle: "Bucket" +weight: 50 +--- + diff --git a/content/en/docs/next/applications/_include/opensearch.md b/content/en/docs/next/applications/_include/opensearch.md new file mode 100644 index 000000000..e1812b2ac --- /dev/null +++ b/content/en/docs/next/applications/_include/opensearch.md @@ -0,0 +1,6 @@ +--- +title: "Managed OpenSearch Service" +linkTitle: "OpenSearch" +weight: 50 +--- + diff --git a/content/en/docs/next/applications/_include/valkey.md b/content/en/docs/next/applications/_include/valkey.md new file mode 100644 index 000000000..9372fcded --- /dev/null +++ b/content/en/docs/next/applications/_include/valkey.md @@ -0,0 +1,6 @@ +--- +title: "Managed Valkey Service" +linkTitle: "Valkey" +weight: 50 +--- + diff --git a/content/en/docs/next/kubernetes/_include/kubernetes-nodes.md b/content/en/docs/next/kubernetes/_include/kubernetes-nodes.md new file mode 100644 index 000000000..5031ef9a1 --- /dev/null +++ b/content/en/docs/next/kubernetes/_include/kubernetes-nodes.md @@ -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 +--- + diff --git a/content/en/docs/next/operations/services/_include/computeplane.md b/content/en/docs/next/operations/services/_include/computeplane.md new file mode 100644 index 000000000..407872ebb --- /dev/null +++ b/content/en/docs/next/operations/services/_include/computeplane.md @@ -0,0 +1,5 @@ +--- +title: "ComputePlane Service Reference" +linkTitle: "ComputePlane" +--- + diff --git a/content/en/docs/next/operations/services/_include/gateway.md b/content/en/docs/next/operations/services/_include/gateway.md new file mode 100644 index 000000000..691930902 --- /dev/null +++ b/content/en/docs/next/operations/services/_include/gateway.md @@ -0,0 +1,5 @@ +--- +title: "Tenant Gateway Reference" +linkTitle: "Gateway" +--- + diff --git a/hack/update_apps.sh b/hack/update_apps.sh index f74a995b0..6c5d71b62 100755 --- a/hack/update_apps.sh +++ b/hack/update_apps.sh @@ -19,6 +19,8 @@ Options: Notes: * Template markdown files are expected in DEST_DIR/_include (derived automatically). * Each template file should be named .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 @@ -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 @@ -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..." @@ -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"