Fix documentation links to work on both GitHub and learn site (#21690)
Convert /docs/... URLs (which only work on learn site) to repo-root relative paths (which work on both GitHub and learn site).
Costa Tsaousis committed
Feb 1, 2026 at 14:20 UTC
0f2497ca8a10bee7a0bb53234ddbf98b61521086
7 files changed
+25
-25
docs/learn/node-identities.md
+3
-3
@@ -86,7 +86,7 @@ If two Agents have the same Machine GUID:
86
- Cloud kicks the older connection offline when the second connects
87
- This causes unstable "flapping" connections
88
89
-See [VM Templates](/docs/netdata-agent/vm-templates) for how to avoid this when cloning VMs.
89
+See [VM Templates](/docs/learn/vm-templates.md) for how to avoid this when cloning VMs.
90
91
:::
92
@@ -124,7 +124,7 @@ When a database contains metadata for multiple nodes (from Children or [Virtual
124
1. **Reports all nodes** - All known nodes are reported to Netdata Cloud
125
2. **Retention persistence** - Node entries persist in Cloud until database retention expires (can be years with tiering)
126
127
-This is normal for Parent nodes receiving data from Children, and for Agents using Virtual Nodes. See [VM Templates](/docs/netdata-agent/vm-templates) for implications when cloning VMs.
127
+This is normal for Parent nodes receiving data from Children, and for Agents using Virtual Nodes. See [VM Templates](/docs/learn/vm-templates.md) for implications when cloning VMs.
128
129
## Virtual Nodes (vnodes)
130
@@ -232,7 +232,7 @@ Read the file `/var/lib/netdata/registry/netdata.public.unique.id`.
232
<details>
233
<summary>Can I change my node's Machine GUID?</summary>
234
235
-Yes, but it will appear as a new node in Netdata Cloud and Netdata Parents. Delete the GUID file and status backups, then restart Netdata. See [VM Templates](/docs/netdata-agent/vm-templates) for the complete procedure.
235
+Yes, but it will appear as a new node in Netdata Cloud and Netdata Parents. Delete the GUID file and status backups, then restart Netdata. See [VM Templates](/docs/learn/vm-templates.md) for the complete procedure.
236
237
</details>
238
docs/learn/vm-templates.md
+14
-14
@@ -6,8 +6,8 @@
6
7
The commands in this guide **permanently delete**:
8
- All historical metrics
9
-- [Node identity](/docs/netdata-agent/node-identities#agent-self-identity)
10
-- [Cloud connection](/docs/netdata-agent/node-identities#agent-cloud-link-aclk-identity)
9
+- [Node identity](/docs/learn/node-identities.md#agent-self-identity)
10
+- [Cloud connection](/docs/learn/node-identities.md#agent-cloud-link-aclk-identity)
11
- Alert history
12
13
**This is irreversible. There is no undo.**
@@ -27,7 +27,7 @@ How to prepare a VM template so each clone gets a unique Netdata identity and au
27
28
## Prerequisites
29
30
-- **Read first**: [Node Identities](/docs/netdata-agent/node-identities) - understand what you're deleting
30
+- **Read first**: [Node Identities](/docs/learn/node-identities.md) - understand what you're deleting
31
- Netdata installed on a VM
32
- Hypervisor that supports templates or golden images
33
- (Optional) `/etc/netdata/claim.conf` configured for auto-claiming to Cloud
@@ -76,9 +76,9 @@ See [Node Ephemerality](/docs/nodes-ephemerality.md) for full documentation.
76
77
| Category | Files | What's Lost |
78
|----------|-------|-------------|
79
-| **[Agent Identity](/docs/netdata-agent/node-identities#agent-self-identity)** | [GUID file](/docs/netdata-agent/node-identities#agent-self-identity), [status backups](/docs/netdata-agent/node-identities#status-file-backups) | Node identity |
80
-| **[ACLK Auth](/docs/netdata-agent/node-identities#agent-cloud-link-aclk-identity)** | [`cloud.d/`](/docs/netdata-agent/node-identities#agent-cloud-link-aclk-identity) directory | Cloud connection, must re-claim |
81
-| **[Node Metadata](/docs/netdata-agent/node-identities#parent-children-identities)** | `netdata-meta.db*`, `context-meta.db*` | Node metadata, metric mappings |
79
+| **[Agent Identity](/docs/learn/node-identities.md#agent-self-identity)** | [GUID file](/docs/learn/node-identities.md#agent-self-identity), [status backups](/docs/learn/node-identities.md#status-file-backups) | Node identity |
80
+| **[ACLK Auth](/docs/learn/node-identities.md#agent-cloud-link-aclk-identity)** | [`cloud.d/`](/docs/learn/node-identities.md#agent-cloud-link-aclk-identity) directory | Cloud connection, must re-claim |
81
+| **[Node Metadata](/docs/learn/node-identities.md#parent-children-identities)** | `netdata-meta.db*`, `context-meta.db*` | Node metadata, metric mappings |
82
| **Metrics** | `dbengine*` directories (all tiers) | All historical metrics |
83
84
**Keep**: `/etc/netdata/claim.conf` - enables auto-claiming on clones
@@ -143,9 +143,9 @@ Should contain:
143
144
## When Clones Boot
145
146
-1. Netdata starts, no [GUID](/docs/netdata-agent/node-identities#agent-self-identity) found, generates new unique identity
146
+1. Netdata starts, no [GUID](/docs/learn/node-identities.md#agent-self-identity) found, generates new unique identity
147
2. If `claim.conf` exists, auto-claims to Cloud
148
-3. Cloud assigns [Node ID](/docs/netdata-agent/node-identities#cloud-node-identity), new node appears in your Space
148
+3. Cloud assigns [Node ID](/docs/learn/node-identities.md#cloud-node-identity), new node appears in your Space
149
150
Each clone is a unique, independent node.
151
@@ -202,13 +202,13 @@ Each instance installs fresh with unique identity.
202
203
### Clones share the same identity
204
205
-Cause: [GUID recovered from status backup](/docs/netdata-agent/node-identities#status-file-backups). Netdata checks multiple backup locations before generating a new GUID.
205
+Cause: [GUID recovered from status backup](/docs/learn/node-identities.md#status-file-backups). Netdata checks multiple backup locations before generating a new GUID.
206
207
Solution: Delete **all** status file locations, not just the primary GUID file. See the cleanup commands in [Step 2](#2-delete-all-identity-and-data-files).
208
209
### Clones don't connect to Parent
210
211
-Cause: Either clones share the same [Machine GUID](/docs/netdata-agent/node-identities#agent-self-identity) (only one can connect at a time), or `stream.conf` wasn't configured in the template.
211
+Cause: Either clones share the same [Machine GUID](/docs/learn/node-identities.md#agent-self-identity) (only one can connect at a time), or `stream.conf` wasn't configured in the template.
212
213
Solution:
214
- Verify each clone has a unique GUID: `cat /var/lib/netdata/registry/netdata.public.unique.id`
@@ -217,7 +217,7 @@ Solution:
217
218
### Stale "template" node appears in Cloud
219
220
-Cause: [Database files kept](/docs/netdata-agent/node-identities#multiple-node-identities-in-database) from the template. The template's node identity persists in the metadata.
220
+Cause: [Database files kept](/docs/learn/node-identities.md#multiple-node-identities-in-database) from the template. The template's node identity persists in the metadata.
221
222
Solution: Delete databases on all clones. This loses historical metrics but removes the stale node reference.
223
@@ -229,7 +229,7 @@ Solution: Reset `stream.conf` on clones or delete the API key sections that enab
229
230
### Unstable Cloud connections (flapping)
231
232
-Cause: Two agents have the same [Machine GUID](/docs/netdata-agent/node-identities#agent-self-identity). Cloud kicks the older connection offline when the second connects.
232
+Cause: Two agents have the same [Machine GUID](/docs/learn/node-identities.md#agent-self-identity). Cloud kicks the older connection offline when the second connects.
233
234
Solution: Each agent needs a unique GUID. Run the cleanup procedure on affected clones.
235
@@ -279,14 +279,14 @@ This deletes all historical metrics on the clone. If you skip deleting `cloud.d/
279
<details>
280
<summary>What if I reboot a clone?</summary>
281
282
-Identity persists. Netdata only generates a new [GUID](/docs/netdata-agent/node-identities#agent-self-identity) when the file AND all [backups](/docs/netdata-agent/node-identities#status-file-backups) are missing.
282
+Identity persists. Netdata only generates a new [GUID](/docs/learn/node-identities.md#agent-self-identity) when the file AND all [backups](/docs/learn/node-identities.md#status-file-backups) are missing.
283
284
</details>
285
286
<details>
287
<summary>Can multiple clones use the same claim token?</summary>
288
289
-Yes. Each clone gets a unique [Machine GUID](/docs/netdata-agent/node-identities#agent-self-identity) and [Claimed ID](/docs/netdata-agent/node-identities#agent-cloud-link-aclk-identity). They authenticate with the same token but appear as separate nodes.
289
+Yes. Each clone gets a unique [Machine GUID](/docs/learn/node-identities.md#agent-self-identity) and [Claimed ID](/docs/learn/node-identities.md#agent-cloud-link-aclk-identity). They authenticate with the same token but appear as separate nodes.
290
291
</details>
292
src/health/REFERENCE.md
+1
-1
@@ -317,7 +317,7 @@ Complete syntax reference for all alert configuration options. Use this section
317
318
Alarms are processed before templates. If you have `alarm` and `template` entities with the same name that both match the same chart, only the `alarm` will create an active alert for that chart.
319
320
-For complete details on configuration loading order and precedence rules, see [Alert Configuration Ordering](/docs/alerts-and-notifications/alert-configuration-ordering).
320
+For complete details on configuration loading order and precedence rules, see [Alert Configuration Ordering](/src/health/alert-configuration-ordering.md).
321
322
:::
323
src/health/alert-configuration-ordering.md
+2
-2
@@ -184,5 +184,5 @@ This is different from alert-level overriding. With shadowing, you must include
184
185
## Related Documentation
186
187
-- [Health Configuration Reference](/docs/alerts-and-notifications/alert-configuration-reference)
188
-- [Overriding Stock Alerts](/docs/alerts-and-notifications/overriding-stock-alerts)
187
+- [Health Configuration Reference](/src/health/REFERENCE.md)
188
+- [Overriding Stock Alerts](/src/health/overriding-stock-alerts.md)
src/health/overriding-stock-alerts.md
+3
-3
@@ -17,7 +17,7 @@ Netdata's alerting uses **templates** (match all instances of a context) and **a
17
18
To override, create an alert with the **same name**. User definitions are processed before stock definitions, so yours wins.
19
20
-See [Alert Configuration Ordering](/docs/alerts-and-notifications/alert-configuration-ordering) for the full conceptual explanation.
20
+See [Alert Configuration Ordering](/src/health/alert-configuration-ordering.md) for the full conceptual explanation.
21
22
## Where to Put Your Overrides
23
@@ -345,5 +345,5 @@ To restore file-based control, remove the dynamic config through the UI (reset t
345
346
## Related Documentation
347
348
-- [Health Configuration Reference](/docs/alerts-and-notifications/alert-configuration-reference)
349
-- [Alert Configuration Ordering](/docs/alerts-and-notifications/alert-configuration-ordering)
348
+- [Health Configuration Reference](/src/health/REFERENCE.md)
349
+- [Alert Configuration Ordering](/src/health/alert-configuration-ordering.md)
src/plugins.d/FUNCTION_UI_DEVELOPER_GUIDE.md
+1
-1
@@ -1,6 +1,6 @@
1
# Netdata Functions: Developer Guide
2
3
-> **Note**: This is the practical developer guide. For the complete technical specification, see [Functions v3 Protocol Reference](/docs/developer-and-contributor-corner/external-plugins/functions-v3-protocol-reference).
3
+> **Note**: This is the practical developer guide. For the complete technical specification, see [Functions v3 Protocol Reference](/src/plugins.d/FUNCTION_UI_REFERENCE.md).
4
5
## Overview
6
src/plugins.d/FUNCTION_UI_REFERENCE.md
+1
-1
@@ -1,6 +1,6 @@
1
# Netdata Functions v3 Protocol - Technical Reference
2
3
-> **Note**: This is the technical specification. For a practical guide to implementing functions, see [Functions Developer Guide](/docs/developer-and-contributor-corner/external-plugins/functions-developer-guide).
3
+> **Note**: This is the technical specification. For a practical guide to implementing functions, see [Functions Developer Guide](/src/plugins.d/FUNCTION_UI_DEVELOPER_GUIDE.md).
4
5
## Overview
6