Update guidelines.md (#14649)
Chris Akritidis committed
Mar 2, 2023 at 11:21 UTC
c4d8d35b9f065f2a847f2780acb4342dabdfd34c
1 file changed
+17
docs/guidelines.md
+17
@@ -54,6 +54,23 @@ Editing documentation locally is the preferred method for completely new documen
54
documents. Clone the repository where you wish to make your changes, work on a new branch and create a pull request
55
with that branch.
56
57
+### Links to other documents
58
+
59
+Please ensure that any links to a different documentation resource are fully expanded URLs to the relevant markdown document,
60
+not links to learn.netdata.cloud.
61
+
62
+e.g.
63
+```
64
+[Correct link to this document](https://github.com/netdata/netdata/blob/master/docs/guidelines.md)
65
+vs
66
+[Incorrect link to this document](https://learn.netdata.cloud/XYZ)
67
+```
68
+
69
+This permalink ensures that the link will not be broken by any future restructuring in learn.netdata.cloud.
70
+
71
+You can see the URL to the source of any published documentation page in the **Edit this page** link at the bottom. If you
72
+just replace `edit` with `blob` in that URL, you have the permalink to the original markdown document.
73
+
74
### Making a pull request
75
76
Pull requests (PRs) should be concise and informative. See our