archive/netdata_netdata
0
0
Fork 0
mirror of https://github.com/netdata/netdata.git synced 2025-04-28 06:32:30 +00:00
Code Issues Projects Releases Wiki Activity

Update guidelines.md ()

Browse source
This commit is contained in:
Chris Akritidis 2023-03-02 11:21:26 -08:00 • committed by GitHub
parent ab944a349f
commit c4d8d35b9f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 0 deletions

17
docs/guidelines.md
View file

@ -54,6 +54,23 @@ Editing documentation locally is the preferred method for completely new documen
documents. Clone the repository where you wish to make your changes, work on a new branch and create a pull request
with that branch.
### Links to other documents
Please ensure that any links to a different documentation resource are fully expanded URLs to the relevant markdown document,
not links to learn.netdata.cloud.
e.g.
```
[Correct link to this document](https://github.com/netdata/netdata/blob/master/docs/guidelines.md)
vs
[Incorrect link to this document](https://learn.netdata.cloud/XYZ)
```
This permalink ensures that the link will not be broken by any future restructuring in learn.netdata.cloud.
You can see the URL to the source of any published documentation page in the **Edit this page** link at the bottom. If you
just replace `edit` with `blob` in that URL, you have the permalink to the original markdown document.
### Making a pull request
Pull requests (PRs) should be concise and informative. See our