summaryrefslogtreecommitdiffstats
path: root/docs/developer-and-contributor-corner
diff options
context:
space:
mode:
authorIlya Mashchenko <ilya@netdata.cloud>2024-05-19 22:19:48 +0300
committerGitHub <noreply@github.com>2024-05-19 22:19:48 +0300
commitb6617322fcbdf90e0d9f71476dd07debe1061915 (patch)
treece23d1ddfe6037331d4562c33951974b324b3fb4 /docs/developer-and-contributor-corner
parentc57a49caf8463792a19df10d98d1c8340eb96ab1 (diff)
some markdown fixes (#17703)
Diffstat (limited to 'docs/developer-and-contributor-corner')
-rw-r--r--docs/developer-and-contributor-corner/style-guide.md18
1 files changed, 8 insertions, 10 deletions
diff --git a/docs/developer-and-contributor-corner/style-guide.md b/docs/developer-and-contributor-corner/style-guide.md
index 3c723333a9..319ea7ee19 100644
--- a/docs/developer-and-contributor-corner/style-guide.md
+++ b/docs/developer-and-contributor-corner/style-guide.md
@@ -25,8 +25,7 @@ One way we write empowering, educational content is by using a consistent voice
_Voice_ is like your personality, which doesn't really change day to day.
_Tone_ is how you express your personality. Your expression changes based on your attitude or mood, or based on who
-you're around. In writing, your reflect tone in your word choice, punctuation, sentence structure, or even the use of
-emoji.
+you're around. In writing, you reflect tone in your word choice, punctuation, sentence structure, or emoji.
The same idea about voice and tone applies to organizations, too. Our voice shouldn't change much between two pieces of
content, no matter who wrote each, but the tone might be quite different based on who we think is reading.
@@ -242,9 +241,8 @@ reader.
| 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
-Markdown syntax and path structure of inter-documentation links.
+Use links as often as required to provide necessary context. Blog posts and guides require fewer hyperlinks than
+documentation.
### Contractions
@@ -302,9 +300,9 @@ 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`. |
+| | |
+|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 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/netdata-agent/configuration/README.md#the-netdata-config-directory), which is typically at `/etc/netdata`, then running `sudo edit-config netdata.conf`. |
### `sudo`
@@ -466,14 +464,14 @@ The following tables describe the standard spelling, capitalization, and usage o
| 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/src/claim/README.md). The claimed node will then appear in your Space and any War Rooms you added it to. |
+| **claimed node** | A node that you've proved ownership of by completing the [connecting to Cloud process](https://github.com/netdata/netdata/blob/master/src/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 />In general, focus on the user's goals, actions, and solutions rather than what the company provides. For example, write _Learn more about enabling alert notifications on your preferred platforms_ instead of _Netdata sends alert notifications to your preferred platforms_. |
| **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. |
| **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 />Never use _Cloud_ without the preceding _Netdata_ to avoid ambiguity. |
| **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](https://github.com/netdata/netdata/blob/master/src/aclk/README.md). Unreachable could mean the node no longer exists or is experiencing network connectivity issues with Cloud. |
+| **unreachable node** | A connected node with a disrupted [Agent-Cloud link](https://github.com/netdata/netdata/blob/master/src/aclk/README.md). 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 alert 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. |