Skip to content

docs: fix broken link, update autoscaler reference, and correct spelling#1486

Open
Copilot wants to merge 2 commits intomainfrom
copilot/fix-node-autoscaling-link
Open

docs: fix broken link, update autoscaler reference, and correct spelling#1486
Copilot wants to merge 2 commits intomainfrom
copilot/fix-node-autoscaling-link

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 3, 2026

Three small documentation fixes across the ops/auth docs.

  • docs/dr/runbook.md — Fix broken relative link: ./node-autoscaling.md../node-autoscaling.md (file lives one level above dr/)
  • docs/node-autoscaling.md — Replace link to internal autoscaler implementation code with the user-facing cluster-autoscaler FAQ
  • docs/oidc-kubectl.mdorganisationorganization (American English consistency)
Original prompt
Please apply the following diffs and create a pull request.
Once the PR is ready, give it a title based on the messages of the fixes being applied.

[{"message":"The link to 'node-autoscaling.md' is incorrect. The file is located at '../node-autoscaling.md' (one directory level up), not in the same 'dr/' directory.","fixFiles":[{"filePath":"docs/dr/runbook.md","diff":"diff --git a/docs/dr/runbook.md b/docs/dr/runbook.md\n--- a/docs/dr/runbook.md\n+++ b/docs/dr/runbook.md\n@@ -308,6 +308,6 @@\n \n ## Related documents\n \n-- [Node autoscaling](./node-autoscaling.md) — architecture, prerequisites, and troubleshooting\n+- [Node autoscaling](../node-autoscaling.md) — architecture, prerequisites, and troubleshooting\n - [Velero + CNPG → R2](./velero-cnpg.md) — application/PV backups\n - [Alerting](./alerting.md) — automated detection of backup failures\n"}]},{"message":"The linked source code file may not be the most appropriate documentation reference for end users. Consider linking to official Hetzner Cloud documentation or the autoscaler's user-facing documentation instead of directly to implementation code.","fixFiles":[{"filePath":"docs/node-autoscaling.md","diff":"diff --git a/docs/node-autoscaling.md b/docs/node-autoscaling.md\n--- a/docs/node-autoscaling.md\n+++ b/docs/node-autoscaling.md\n@@ -38,7 +38,7 @@\n   Hetzner volume, no Longhorn storage). Static KSail workers have\n   dedicated Hetzner volumes and serve as Longhorn storage nodes. Pods on\n   autoscaler nodes access Longhorn PVCs via the CSI driver (network).\n-  The Hetzner Cluster Autoscaler [does not support volume attachment](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/hetzner/hetzner_node_group.go).\n+  The Hetzner Cluster Autoscaler [does not support volume attachment](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md).\n \n ### How new nodes join\n \n"}]},{"message":"Corrected spelling of 'organisation' to 'organization' for consistency with American English spelling conventions commonly used in technical documentation.","fixFiles":[{"filePath":"docs/oidc-kubectl.md","diff":"diff --git a/docs/oidc-kubectl.md b/docs/oidc-kubectl.md\n--- a/docs/oidc-kubectl.md\n+++ b/docs/oidc-kubectl.md\n@@ -5,7 +5,7 @@\n ## Prerequisites\n \n - Access to the cluster (kubeconfig with server address)\n-- A GitHub account that is a member of the [`devantler-tech`](https://github.com/devantler-tech) organisation\n+- A GitHub account that is a member of the [`devantler-tech`](https://github.com/devantler-tech) organization\n - The `oidc-admin` ClusterRoleBinding must list your OIDC identity (see [RBAC](#rbac))\n \n ## 1 — Install kubelogin\n"}]}]

Copilot AI changed the title [WIP] Fix incorrect link to node-autoscaling in runbook docs: fix broken link, update autoscaler reference, and correct spelling May 3, 2026
Copilot AI requested a review from devantler May 3, 2026 20:29
@devantler devantler marked this pull request as ready for review May 3, 2026 20:34
Copilot AI review requested due to automatic review settings May 3, 2026 20:34
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR makes small documentation-only fixes across DR, autoscaling, and OIDC kubectl auth guides to improve correctness and usability of references.

Changes:

  • Fix a broken relative link in the DR runbook to the node autoscaling document.
  • Update the node autoscaling document to link to upstream autoscaler documentation instead of implementation code.
  • Correct “organisation” → “organization” for spelling consistency.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
docs/dr/runbook.md Fixes the relative path for the Node autoscaling reference in “Related documents”.
docs/node-autoscaling.md Changes the reference link supporting the “no volume attachment” statement to upstream autoscaler docs.
docs/oidc-kubectl.md Updates spelling in prerequisites (“organisation” → “organization”).

Comment thread docs/node-autoscaling.md
dedicated Hetzner volumes and serve as Longhorn storage nodes. Pods on
autoscaler nodes access Longhorn PVCs via the CSI driver (network).
The Hetzner Cluster Autoscaler [does not support volume attachment](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/hetzner/hetzner_node_group.go).
The Hetzner Cluster Autoscaler [does not support volume attachment](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not a very helpful link either. You need to find a link that backs up this claim (for example by linking to the relevant section in a page instead of to a full page), or remove the paragraph

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 🫴 Ready

Development

Successfully merging this pull request may close these issues.

3 participants