summaryrefslogtreecommitdiffstats
path: root/contribution-guidelines.md
diff options
context:
space:
mode:
authorTasos Katsoulas <12612986+tkatsoulas@users.noreply.github.com>2023-02-02 15:23:54 +0200
committerGitHub <noreply@github.com>2023-02-02 15:23:54 +0200
commit9f1403de7d3ea2633768d34095afcf880c7c4e2d (patch)
tree0c50a1f42b3e182f6cd5de4e92c609cc76fd3cb5 /contribution-guidelines.md
parentcaf18920aac38eed782647957e82c0ab7f64ec17 (diff)
Covert our documentation links to GH absolute links (#14344)
Signed-off-by: Tasos Katsoulas <tasos@netdata.cloud>
Diffstat (limited to 'contribution-guidelines.md')
-rw-r--r--contribution-guidelines.md272
1 files changed, 158 insertions, 114 deletions
diff --git a/contribution-guidelines.md b/contribution-guidelines.md
index 7851f5f8ed..f659298035 100644
--- a/contribution-guidelines.md
+++ b/contribution-guidelines.md
@@ -2,40 +2,52 @@
Welcome to our docs developer guidelines!
-We store documentation related to Netdata inside of the [`netdata/netdata` repository](https://github.com/netdata/netdata) on GitHub.
+We store documentation related to Netdata inside of
+the [`netdata/netdata` repository](https://github.com/netdata/netdata) on GitHub.
The Netdata team aggregates and publishes all documentation at [learn.netdata.cloud](/) using
[Docusaurus](https://v2.docusaurus.io/) over at the [`netdata/learn` repository](https://github.com/netdata/learn).
## Before you get started
-Anyone interested in contributing to documentation should first read the [Netdata style guide](#styling-guide) further down below and the [Netdata Community Code of Conduct](/contribute/code-of-conduct).
+Anyone interested in contributing to documentation should first read the [Netdata style guide](#styling-guide) further
+down below and the [Netdata Community Code of Conduct](https://github.com/netdata/.github/blob/main/CODE_OF_CONDUCT.md).
-Netdata's documentation uses Markdown syntax. If you're not familiar with Markdown, read the [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) guide from GitHub for the basics on creating paragraphs, styled text, lists, tables, and more, and read further down about some special occasions [while writing in MDX](#mdx-and-markdown).
+Netdata's documentation uses Markdown syntax. If you're not familiar with Markdown, read
+the [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) guide from GitHub for the basics on
+creating paragraphs, styled text, lists, tables, and more, and read further down about some special
+occasions [while writing in MDX](#mdx-and-markdown).
### Netdata's Documentation structure
Netdata's documentation is separated into 5 categories.
-- **Getting Started**: This section’s purpose is to present “What is Netdata” and for whom is it for while also presenting all the ways Netdata can be deployed. That includes Netdata’s platform support, Standalone deployment, Parent-child deployments, deploying on Kubernetes and also deploying on IoT nodes.
- - Stored in **WIP**
- - Published in **WIP**
-- **Concepts**: This section’s purpose is to take a pitch on all the aspects of Netdata. We present the functionality of each component/idea and support it with examples but we don’t go deep into technical details.
- - Stored in the `/docs/concepts` directory in the `netdata/netdata` repository.
- - Published in **WIP**
-- **Tasks**: This section's purpose is to break down any operation into a series of fundamental tasks for the Netdata solution.
- - Stored in the `/docs/tasks` directory in the `netdata/netdata` repository.
- - Published in **WIP**
-- **References**: This section’s purpose is to explain thoroughly every part of Netdata. That covers settings, configurations and so on.
- - Stored near the component they refer to.
- - Published in **WIP**
-- **Collectors References**: This section’s purpose is to explain thoroughly every collector that Netdata supports and it's configuration options.
- - Stored in stored near the collector they refer to.
- - Published in **WIP**
+- **Getting Started**: This section’s purpose is to present “What is Netdata” and for whom is it for while also
+ presenting all the ways Netdata can be deployed. That includes Netdata’s platform support, Standalone deployment,
+ Parent-child deployments, deploying on Kubernetes and also deploying on IoT nodes.
+ - Stored in **WIP**
+ - Published in **WIP**
+- **Concepts**: This section’s purpose is to take a pitch on all the aspects of Netdata. We present the functionality of
+ each component/idea and support it with examples but we don’t go deep into technical details.
+ - Stored in the `/docs/concepts` directory in the `netdata/netdata` repository.
+ - Published in **WIP**
+- **Tasks**: This section's purpose is to break down any operation into a series of fundamental tasks for the Netdata
+ solution.
+ - Stored in the `/docs/tasks` directory in the `netdata/netdata` repository.
+ - Published in **WIP**
+- **References**: This section’s purpose is to explain thoroughly every part of Netdata. That covers settings,
+ configurations and so on.
+ - Stored near the component they refer to.
+ - Published in **WIP**
+- **Collectors References**: This section’s purpose is to explain thoroughly every collector that Netdata supports and
+ it's configuration options.
+ - Stored in stored near the collector they refer to.
+ - Published in **WIP**
## How to contribute
-The easiest way to contribute to Netdata's documentation is to edit a file directly on GitHub. This is perfect for small fixes to a single document, such as fixing a typo or clarifying a confusing sentence.
+The easiest way to contribute to Netdata's documentation is to edit a file directly on GitHub. This is perfect for small
+fixes to a single document, such as fixing a typo or clarifying a confusing sentence.
Click on the **Edit this page** button on any published document on [Netdata Learn](https://learn.netdata.cloud). Each
page has two of these buttons: One beneath the table of contents, and another at the end of the document, which take you
@@ -49,28 +61,39 @@ Jump down to our instructions on [PRs](#making-a-pull-request) for your next ste
### Edit locally
-Editing documentation locally is the preferred method for complex changes that span multiple documents or change the documentation's style or structure.
+Editing documentation locally is the preferred method for complex changes that span multiple documents or change the
+documentation's style or structure.
-Create a fork of the Netdata Agent repository by visit the [Netdata repository](https://github.com/netdata/netdata) and clicking on the **Fork** button.
+Create a fork of the Netdata Agent repository by visit the [Netdata repository](https://github.com/netdata/netdata) and
+clicking on the **Fork** button.
-GitHub will ask you where you want to clone the repository. When finished, you end up at the index of your forked Netdata Agent repository. Clone your fork to your local machine:
+GitHub will ask you where you want to clone the repository. When finished, you end up at the index of your forked
+Netdata Agent repository. Clone your fork to your local machine:
```bash
git clone https://github.com/YOUR-GITHUB-USERNAME/netdata.git
```
-Create a new branch using `git checkout -b BRANCH-NAME`. Use your favorite text editor to make your changes, keeping the [Netdata style guide](/contribute/style-guide) in mind. Add, commit, and push changes to your fork. When you're finished, visit the [Netdata Agent Pull requests](https://github.com/netdata/netdata/pulls) to create a new pull request based on the changes you made in the new branch of your fork.
+Create a new branch using `git checkout -b BRANCH-NAME`. Use your favorite text editor to make your changes, keeping
+the [Netdata style guide](https://github.com/netdata/netdata/blob/master/docs/contributing/style-guide.md) in mind. Add, commit, and push changes to your fork. When you're
+finished, visit the [Netdata Agent Pull requests](https://github.com/netdata/netdata/pulls) to create a new pull request
+based on the changes you made in the new branch of your fork.
### Making a pull request
-Pull requests (PRs) should be concise and informative. See our [PR guidelines](/contribute/handbook#pr-guidelines) for specifics.
+Pull requests (PRs) should be concise and informative. See our [PR guidelines](/contribute/handbook#pr-guidelines) for
+specifics.
-- The title must follow the [imperative mood](https://en.wikipedia.org/wiki/Imperative_mood) and be no more than ~50 characters.
-- The description should explain what was changed and why. Verify that you tested any code or processes that you are trying to change.
+- The title must follow the [imperative mood](https://en.wikipedia.org/wiki/Imperative_mood) and be no more than ~50
+ characters.
+- The description should explain what was changed and why. Verify that you tested any code or processes that you are
+ trying to change.
-The Netdata team will review your PR and assesses it for correctness, conciseness, and overall quality. We may point to specific sections and ask for additional information or other fixes.
+The Netdata team will review your PR and assesses it for correctness, conciseness, and overall quality. We may point to
+specific sections and ask for additional information or other fixes.
-After merging your PR, the Netdata team rebuilds the [documentation site](https://learn.netdata.cloud) to publish the changed documentation.
+After merging your PR, the Netdata team rebuilds the [documentation site](https://learn.netdata.cloud) to publish the
+changed documentation.
## Writing Docs
@@ -78,34 +101,43 @@ We have three main types of Docs: **References**, **Concepts** and **Tasks**.
### Metadata Tags
-
All of the Docs however have what we call "metadata" tags. these help to organize the document upon publishing.
So let's go through the different necessary metadata tags to get a document properly published on Learn:
- Docusaurus Specific:\
-These metadata tags are parsed automatically by Docusaurus and are rendered in the published document. **Note**: Netdata only uses the Docusaurus metadata tags releveant for our documentation infrastructure.
- - `title: "The title of the document"` : Here we specify the title of our document, which is going to be converted to the heading of the published page.
- - `description: "The description of the file"`: Here we give a description of what this file is about.
- - `custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/COLLECTORS.md`: Here is an example of the link that the user will be redirected to if he clicks the "Edit this page button", as you see it leads directly to the edit page of the source file.
+ These metadata tags are parsed automatically by Docusaurus and are rendered in the published document. **Note**:
+ Netdata only uses the Docusaurus metadata tags releveant for our documentation infrastructure.
+ - `title: "The title of the document"` : Here we specify the title of our document, which is going to be converted
+ to the heading of the published page.
+ - `description: "The description of the file"`: Here we give a description of what this file is about.
+ - `custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/COLLECTORS.md`: Here is an example of
+ the link that the user will be redirected to if he clicks the "Edit this page button", as you see it leads
+ directly to the edit page of the source file.
- Netdata Learn specific:
- - `learn_status: "..."`
- - The options for this tag are:
- - `"published"`
- - `"unpublished"`
- - `learn_topic_type: "..."`
- - The options for this tag are:
- - `"Getting Started"`
- - `"Concepts"`
- - `"Tasks"`
- - `"References"`
- - `"Collectors References"`
- - This is the Topic that the file belongs to, and this is going to resemble the start directory of the file's path on Learn for example if we write `"Concepts"` in the field, then the file is going to be placed under `/Concepts/....` inside Learn.
- - `learn_rel_path: "/example/"`
- - This tag represents the rest of the path, without the filename in the end, so in this case if the file is a Concept, it would go under `Concepts/example/filename.md`. If you want to place the file under the "root" topic folder, input `"/"`.
- - ⚠️ In case any of these "Learn" tags are missing or falsely inputted the file will remain unpublished. This is by design to prevent non-properly tagged files from getting published.
-
-While Docusaurus can make use of more metadata tags than the above, these are the minimum we require to publish the file on Learn.
+ - `learn_status: "..."`
+ - The options for this tag are:
+ - `"published"`
+ - `"unpublished"`
+ - `learn_topic_type: "..."`
+ - The options for this tag are:
+ - `"Getting Started"`
+ - `"Concepts"`
+ - `"Tasks"`
+ - `"References"`
+ - `"Collectors References"`
+ - This is the Topic that the file belongs to, and this is going to resemble the start directory of the file's
+ path on Learn for example if we write `"Concepts"` in the field, then the file is going to be placed
+ under `/Concepts/....` inside Learn.
+ - `learn_rel_path: "/example/"`
+ - This tag represents the rest of the path, without the filename in the end, so in this case if the file is a
+ Concept, it would go under `Concepts/example/filename.md`. If you want to place the file under the "root"
+ topic folder, input `"/"`.
+ - ⚠️ In case any of these "Learn" tags are missing or falsely inputted the file will remain unpublished. This is by
+ design to prevent non-properly tagged files from getting published.
+
+While Docusaurus can make use of more metadata tags than the above, these are the minimum we require to publish the file
+on Learn.
### Doc Templates
@@ -193,10 +225,10 @@ Needs only `url` to server's `server-status?auto`. Here is an example for 2 serv
```yaml
jobs:
-- name: local
- url: http://127.0.0.1/server-status?auto
-- name: remote
- url: http://203.0.113.10/server-status?auto
+ - name: local
+ url: http://127.0.0.1/server-status?auto
+ - name: remote
+ url: http://203.0.113.10/server-status?auto
```
For all available options please see
@@ -234,7 +266,8 @@ Describe all the information that the user needs to know before proceeding with
## Context
-Describe the background information of the Task, the purpose of the Task, and what will the user achieve by completing it.
+Describe the background information of the Task, the purpose of the Task, and what will the user achieve by completing
+it.
## Steps
@@ -268,7 +301,8 @@ The template of the Concept files is:
## Description
-In our concepts we have a more loose structure, the goal is to communicate the "concept" to the user, starting with simple language that even a new user can understand, and building from there.
+In our concepts we have a more loose structure, the goal is to communicate the "concept" to the user, starting with
+simple language that even a new user can understand, and building from there.
</details>
@@ -335,7 +369,8 @@ Netdata is a global company in every sense, with employees, contributors, and us
communicate in a way that is clear and easily understood by everyone.
Here are some guidelines, pointers, and questions to be aware of as you write to ensure your writing is universal. Some
-of these are expanded into individual sections in the [language, grammar, and mechanics](#language-grammar-and-mechanics) section below.
+of these are expanded into individual sections in
+the [language, grammar, and mechanics](#language-grammar-and-mechanics) section below.
- Would this language make sense to someone who doesn't work here?
- Could someone quickly scan this document and understand the material?
@@ -364,8 +399,8 @@ of these are expanded into individual sections in the [language, grammar, and me
To ensure Netdata's writing is clear, concise, and universal, we have established standards for language, grammar, and
certain writing mechanics. However, if you're writing about Netdata for an external publication, such as a guest blog
-post, follow that publication's style guide or standards, while keeping the [preferred spelling of Netdata
-terms](#netdata-specific-terms) in mind.
+post, follow that publication's style guide or standards, while keeping
+the [preferred spelling of Netdata terms](#netdata-specific-terms) in mind.
### Active voice
@@ -374,7 +409,7 @@ the sentence is action. In passive voice, the subject is acted upon. A famous ex
"mistakes were made."
| | |
-| --------------- | ----------------------------------------------------------------------------------------- |
+|-----------------|-------------------------------------------------------------------------------------------|
| Not recommended | When an alarm is triggered by a metric, a notification is sent by Netdata. |
| **Recommended** | When a metric triggers an alarm, Netdata sends a notification to your preferred endpoint. |
@@ -388,16 +423,16 @@ implied, depending on your sentence structure.
One valid exception is when a member of the Netdata team or community wants to write about said team or community.
| | |
-| ------------------------------ | ------------------------------------------------------------ |
+|--------------------------------|--------------------------------------------------------------|
| Not recommended | To install Netdata, we should try the one-line installer... |
| **Recommended** | To install Netdata, you should try the one-line installer... |
| **Recommended**, implied "you" | To install Netdata, try the one-line installer... |
### "Easy" or "simple"
-Using words that imply the complexity of a task or feature goes against our policy of [universal
-communication](#universal-communication). If you claim that a task is easy and the reader struggles to complete it, you
-may inadvertently discourage them.
+Using words that imply the complexity of a task or feature goes against our policy
+of [universal communication](#universal-communication). If you claim that a task is easy and the reader struggles to
+complete it, you may inadvertently discourage them.
However, if you give users two options and want to relay that one option is genuinely less complex than another, be
specific about how and why.
@@ -433,7 +468,7 @@ capitalization. In summary:
- Capitalize the first word of every new sentence.
- Don't use uppercase for emphasis. (Netdata is the BEST!)
- Capitalize the names of brands, software, products, and companies according to their official guidelines. (Netdata,
- Docker, Apache, NGINX)
+ Docker, Apache, NGINX)
- Avoid camel case (NetData) or all caps (NETDATA).
Whenever you refer to the company Netdata, Inc., or the open-source monitoring agent the company develops, capitalize
@@ -443,7 +478,7 @@ However, if you are referring to a process, user, or group on a Linux system, us
inline code block: `` `netdata` ``.
| | |
-| --------------- | ---------------------------------------------------------------------------------------------- |
+|-----------------|------------------------------------------------------------------------------------------------|
| Not recommended | The netdata agent, which spawns the netdata process, is actively maintained by netdata, inc. |
| **Recommended** | The Netdata Agent, which spawns the `netdata` process, is actively maintained by Netdata, Inc. |
@@ -457,7 +492,7 @@ guidelines.
Also, don't put a period (`.`) or colon (`:`) at the end of a title or header.
| | |
-| --------------- | --------------------------------------------------------------------------------------------------- |
+|-----------------|-----------------------------------------------------------------------------------------------------|
| Not recommended | Getting Started Guide <br />Service Discovery and Auto-Detection: <br />Install netdata with docker |
| **Recommended** | Getting started guide <br />Service discovery and auto-detection <br />Install Netdata with Docker |
@@ -471,7 +506,7 @@ When introducing an abbreviation to a document for the first time, give the read
shortened version at the same time. For example:
> Use Netdata to monitor Extended Berkeley Packet Filter (eBPF) metrics in real-time.
-After you define an abbreviation, don't switch back and forth. Use only the abbreviation for the rest of the document.
+> After you define an abbreviation, don't switch back and forth. Use only the abbreviation for the rest of the document.
You can also use abbreviations in a document's title to keep the title short and relevant. If you do this, you should
still introduce the spelled-out name alongside the abbreviation as soon as possible.
@@ -482,7 +517,7 @@ When instructing users to take action, give them the context first. By placing t
beginning of the sentence, users can immediately know if they want to read more, follow a link, or skip ahead.
| | |
-| --------------- | ------------------------------------------------------------------------------ |
+|-----------------|--------------------------------------------------------------------------------|
| Not recommended | Read the reference guide if you'd like to learn more about custom dashboards. |
| **Recommended** | If you'd like to learn more about custom dashboards, read the reference guide. |
@@ -492,7 +527,7 @@ The Oxford comma is the comma used after the second-to-last item in a list of th
before "and" or "or."
| | |
-| --------------- | ---------------------------------------------------------------------------- |
+|-----------------|------------------------------------------------------------------------------|
| Not recommended | Netdata can monitor RAM, disk I/O, MySQL queries per second and lm-sensors. |
| **Recommended** | Netdata can monitor RAM, disk I/O, MySQL queries per second, and lm-sensors. |
@@ -501,19 +536,19 @@ before "and" or "or."
Do not mention future releases or upcoming features in writing unless they have been previously communicated via a
public roadmap.
-In particular, documentation must describe, as accurately as possible, the Netdata Agent _as of the [latest
-commit](https://github.com/netdata/netdata/commits/master) in the GitHub repository_. For Netdata Cloud, documentation
-must reflect the *current state* of [production](https://app.netdata.cloud).
+In particular, documentation must describe, as accurately as possible, the Netdata Agent _as of
+the [latest commit](https://github.com/netdata/netdata/commits/master) in the GitHub repository_. For Netdata Cloud,
+documentation must reflect the *current state* of [production](https://app.netdata.cloud).
### Informational links
Every link should clearly state its destination. Don't use words like "here" to describe where a link will take your
reader.
-| | |
-| --------------- | ------------------------------------------------------------------------------------------ |
-| Not recommended | To install Netdata, click [here](/docs/agent/packaging/installer). |
-| **Recommended** | To install Netdata, read the [installation instructions](/docs/agent/packaging/installer). |
+| | |
+|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------|
+| Not recommended | To install Netdata, click [here](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md). |
+| **Recommended** | To install Netdata, read the [installation instructions](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md). |
Use links as often as required to provide necessary context. Blog posts and guides require less hyperlinks than
documentation. See the section on [linking between documentation](#linking-between-documentation) for guidance on the
@@ -546,7 +581,7 @@ Use `NODE` instead of an actual or example IP address/hostname when referencing
or API endpoint in a browser.
| | |
-| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Not recommended | Navigate to `http://example.com:19999` in your browser to see Netdata's dashboard. <br />Navigate to `http://203.0.113.0:19999` in your browser to see Netdata's dashboard. |
| **Recommended** | Navigate to `http://NODE:19999` in your browser to see Netdata's dashboard. |
@@ -563,16 +598,17 @@ Netdata Agent installation will have commands under the same paths. When applica
path, providing a recommendation or instructions on how to view the running configuration, which includes the correct
paths.
-For example, the [configuration](/docs/configure/nodes) doc first teaches users how to find the Netdata config
+For example, the [configuration](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) doc first
+teaches users how to find the Netdata config
directory and navigate to it, then runs commands from the `/etc/netdata` path so that the instructions are more
universal.
Don't include full paths, beginning from the system's root (`/`), as these might not work on certain systems.
-| | |
-| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Not recommended | Use `edit-config` to edit Netdata's configuration: `sudo /etc/netdata/edit-config netdata.conf`. |
-| **Recommended** | Use `edit-config` to edit Netdata's configuration by first navigating to your [Netdata config directory](/docs/configure/nodes#the-netdata-config-directory), which is typically at `/etc/netdata`, then running `sudo edit-config netdata.conf`. |
+| | |
+|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Not recommended | Use `edit-config` to edit Netdata's configuration: `sudo /etc/netdata/edit-config netdata.conf`. |
+| **Recommended** | Use `edit-config` to edit Netdata's configuration by first navigating to your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory), which is typically at `/etc/netdata`, then running `sudo edit-config netdata.conf`. |
### `sudo`
@@ -584,7 +620,7 @@ For example, most users need to use `sudo` with the `edit-config` script, becaus
by the `netdata` user. Same goes for restarting the Netdata Agent with `systemctl`.
| | |
-| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
+|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------|
| Not recommended | Run `edit-config netdata.conf` to configure the Netdata Agent. <br />Run `systemctl restart netdata` to restart the Netdata Agent. |
| **Recommended** | Run `sudo edit-config netdata.conf` to configure the Netdata Agent. <br />Run `sudo systemctl restart netdata` to restart the Netdata Agent. |
@@ -615,14 +651,19 @@ If you want to see all the settings, open the
### MDX and markdown
While writing in Docusaurus, you might want to take leverage of it's features that are supported in MDX formatted files.
-One of those that we use is [Tabs](https://docusaurus.io/docs/next/markdown-features/tabs). They use an HTML syntax, which requires some changes in the way we write markdown inside them.
+One of those that we use is [Tabs](https://docusaurus.io/docs/next/markdown-features/tabs). They use an HTML syntax,
+which requires some changes in the way we write markdown inside them.
In detail:
-Due to a bug with docusaurus, we prefer to use `<h1>heading</h1> instead of # H1` so that docusaurus doesn't render the contents of all Tabs on the right hand side, while not being able to navigate them [relative link](https://github.com/facebook/docusaurus/issues/7008).
+Due to a bug with docusaurus, we prefer to use `<h1>heading</h1> instead of # H1` so that docusaurus doesn't render the
+contents of all Tabs on the right hand side, while not being able to navigate
+them [relative link](https://github.com/facebook/docusaurus/issues/7008).
You can use markdown syntax for every other styling you want to do except Admonitions:
-For admonitions, follow [this](https://docusaurus.io/docs/markdown-features/admonitions#usage-in-jsx) guide to use admonitions inside JSX. While writing in JSX, all the markdown stylings have to be in HTML format to be rendered properly.
+For admonitions, follow [this](https://docusaurus.io/docs/markdown-features/admonitions#usage-in-jsx) guide to use
+admonitions inside JSX. While writing in JSX, all the markdown stylings have to be in HTML format to be rendered
+properly.
### Frontmatter
@@ -645,7 +686,7 @@ this case, replace `/docs` with `/img/seo`, and then rebuild the remainder of th
the path with `.png`. A member of the Netdata team will assist in creating the image when publishing the content.
For example, here is the frontmatter for the guide about [deploying the Netdata Agent with
-Ansible](/guides/deploy/ansible).
+Ansible](https://github.com/netdata/netdata/blob/master/docs/guides/deploy/ansible.md).
```markdown
<!--
@@ -665,23 +706,25 @@ forum](https://community.netdata.cloud/c/blog-posts-and-articles/6).
### Admonitions
-In addition to basic markdown syntax, we also encourage the use of admonition syntax, which allows for a more aesthetically seamless presentation of supplemental information. For general instructions on using admonitions, feel free to read this [feature guide](https://docusaurus.io/docs/markdown-features/admonitions).
+In addition to basic markdown syntax, we also encourage the use of admonition syntax, which allows for a more
+aesthetically seamless presentation of supplemental information. For general instructions on using admonitions, feel
+free to read this [feature guide](https://docusaurus.io/docs/markdown-features/admonitions).
-We encourage the use of **Note** admonitions to provide important supplemental information to a user within a task step, reference item, or concept passage.
+We encourage the use of **Note** admonitions to provide important supplemental information to a user within a task step,
+reference item, or concept passage.
-Additionally, you should use a **Caution** admonition to provide necessary information to present any risk to a user's setup or data.
+Additionally, you should use a **Caution** admonition to provide necessary information to present any risk to a user's
+setup or data.
-**Danger** admonitions should be avoided, as these admonitions are typically applied to reduce physical or bodily harm to an individual.
+**Danger** admonitions should be avoided, as these admonitions are typically applied to reduce physical or bodily harm
+to an individual.
### Linking between documentation
Documentation should link to relevant pages whenever it's relevant and provides valuable context to the reader.
-Links should always reference the full path to the document, beginning at the root of the Netdata Agent repository
-(`/`), and ending with the `.md` file extension. Avoid relative links or traversing up directories using `../`.
-
-For example, if you want to link to our node configuration document, link to `/docs/configure/nodes.md`. To reference
-the guide for deploying the Netdata Agent with Ansible, link to `/docs/guides/deploy/ansible.md`.
+We link between markdown documents by using its GitHub absolute link for
+instance `[short description of what we reference](https://github.com/netdata/netdata/blob/master/contribution-guidelines.md)`
### References to UI elements
@@ -700,7 +743,8 @@ try to supplement the text with an [image](#images).
Don't rely on images to convey features, ideas, or instructions. Accompany every image with descriptive alt text.
-In Markdown, use the standard image syntax, `![](/docs/agent/contributing)`, and place the alt text between the brackets `[]`. Here's an example
+In Markdown, use the standard image syntax, `![](/docs/agent/contributing)`, and place the alt text between the
+brackets `[]`. Here's an example
using our logo:
```markdown
@@ -741,8 +785,8 @@ inline char *health_stock_config_dir(void) {
}
```
-Prism also supports titles and line highlighting. See the [Docusaurus
-documentation](https://v2.docusaurus.io/docs/markdown-features#code-blocks) for more information.
+Prism also supports titles and line highlighting. See
+the [Docusaurus documentation](https://v2.docusaurus.io/docs/markdown-features#code-blocks) for more information.
## Word list
@@ -750,24 +794,24 @@ The following tables describe the standard spelling, capitalization, and usage o
### Netdata-specific terms
-| Term | Definition |
-| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **claimed node** | A node that you've proved ownership of by completing the [connecting to Cloud process](/docs/agent/claim). The claimed node will then appear in your Space and any War Rooms you added it to. |
-| **Netdata** | The company behind the open-source Netdata Agent and the Netdata Cloud web application. Never use *netdata* or *NetData*. <br /><br />**Note:** You should use "Netdata" when referencing any general element, function, or part of the user experience. In general, focus on the user's goals, actions, and solutions rather than what the company provides. For example, write *Learn more about enabling alarm notifications on your preferred platforms* instead of *Netdata sends alarm notifications to your preferred platforms*. |
-| **Netdata Agent** or **Open-source Netdata Agent** | The free and open source [monitoring agent](https://github.com/netdata/netdata) that you can install on all of your distributed systems, whether they're physical, virtual, containerized, ephemeral, and more. The Agent monitors systems running Linux, Docker, Kubernetes, macOS, FreeBSD, and more, and collects metrics from hundreds of popular services and applications. <br /><br /> **Note:** You should avoid referencing the Netdata Agent or Open-source Netdata agent in any scenario that does not specifically require the distinction for clear instructions. |
-| **Netdata Cloud** | The web application hosted at [https://app.netdata.cloud](https://app.netdata.cloud) that helps you monitor an entire infrastructure of distributed systems in real time. <br /><br />**Notes:** Never use *Cloud* without the preceding *Netdata* to avoid ambiguity. You should avoid referencing Netdata Cloud in any scenario that does not specifically require the distinction for clear instructions. | |
-| **Netdata community** | Contributors to any of Netdata's [open-source projects](/contribute/projects), members of the [community forum](https://community.netdata.cloud/). |
-| **Netdata community forum** | The Discourse-powered forum for feature requests, Netdata Cloud technical support, and conversations about Netdata's monitoring and troubleshooting products. |
-| **node** | A system on which the Netdata Agent is installed. The system can be physical, virtual, in a Docker container, and more. Depending on your infrastructure, you may have one, dozens, or hundreds of nodes. Some nodes are *ephemeral*, in that they're created/destroyed automatically by an orchestrator service. |
-| **Space** | The highest level container within Netdata Cloud for a user to organize their team members and nodes within their infrastructure. A Space likely represents an entire organization or a large team. <br /><br />*Space* is always capitalized. |
-| **unreachable node** | A connected node with a disrupted [Agent-Cloud link](/docs/agent/aclk). Unreachable could mean the node no longer exists or is experiencing network connectivity issues with Cloud. |
-| **visited node** | A node which has had its Agent dashboard directly visited by a user. A list of these is maintained on a per-user basis. |
-| **War Room** | A smaller grouping of nodes where users can view key metrics in real-time and monitor the health of many nodes with their alarm status. War Rooms can be used to organize nodes in any way that makes sense for your infrastructure, such as by a service, purpose, physical location, and more. <br /><br />*War Room* is always capitalized. |
+| Term | Definition |
+|----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **claimed node** | A node that you've proved ownership of by completing the [connecting to Cloud process](https://github.com/netdata/netdata/blob/master/claim/README.md). The claimed node will then appear in your Space and any War Rooms you added it to. |
+| **Netdata** | The company behind the open-source Netdata Agent and the Netdata Cloud web application. Never use *netdata* or *NetData*. <br /><br />**Note:** You should use "Netdata" when referencing any general element, function, or part of the user experience. In general, focus on the user's goals, actions, and solutions rather than what the company provides. For example, write *Learn more about