Skip to content

Commit

Permalink
some markdown fixes (netdata#17703)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ilyam8
ilyam8 authored May 19, 2024
1 parent c57a49c commit b661732
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 35 deletions.
2 changes: 1 addition & 1 deletion docs/dashboards-and-charts/events-feed.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ All users will be able to see events from the Topology and Alerts domain but Aud

> **Note**
>
> When you try to query a longer period than what your space allows you will see an error message highlighting that you are querying data outside of your plan.
> When you try to query a longer period than what your space allows you will see an error message highlighting that you are querying data outside your plan.
18 changes: 8 additions & 10 deletions docs/developer-and-contributor-corner/style-guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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. |

Expand Down
16 changes: 8 additions & 8 deletions ...tdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -139,14 +139,14 @@ Estimated total Netdata memory = 3 * 4 + 4 = 16 GiB

The actual measurement during a low usage time was the following:

Purpose|RAM|Note
:--- | ---: | :---
DBENGINE usage | 5.9 GiB | Out of 7GB max
Cardinality/ephemerality related memory (k8s contexts, labels, strings) | 3.4 GiB
Buffer for queries | 0 GiB | Out of 0.5 GiB max, when heavily queried
Other | 0.5 GiB |
System overhead | 4.4 GiB | Calculated by subtracting all of the above from the total
**Total Netdata memory usage** | 14.2 GiB |
| Purpose | RAM | Note |
|:------------------------------------------------------------------------|---------:|:----------------------------------------------------------|
| DBENGINE usage | 5.9 GiB | Out of 7GB max |
| Cardinality/ephemerality related memory (k8s contexts, labels, strings) | 3.4 GiB | |
| Buffer for queries | 0 GiB | Out of 0.5 GiB max, when heavily queried |
| Other | 0.5 GiB | |
| System overhead | 4.4 GiB | Calculated by subtracting all of the above from the total |
| **Total Netdata memory usage** | 14.2 GiB | |

All the figures above except for the system memory management overhead were retrieved from Netdata itself.
The overhead can't be directly calculated, so we subtracted all the other figures from the total Netdata memory usage to get it.
Expand Down
4 changes: 2 additions & 2 deletions ...ervability-centralization-points/metrics-centralization-points/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ To enable the reception of metrics from Netdata Children, generate a random API
uuidgen
```

Then, copy the UUID generated, [edit `stream.conf`](#edit-stream.conf), find the section that reads like the following and replace `API_KEY` with the UUID you generated:
Then, copy the UUID generated, [edit `stream.conf`](#edit-streamconf), find the section that reads like the following and replace `API_KEY` with the UUID you generated:

```ini
[API_KEY]
Expand All @@ -40,7 +40,7 @@ Save the file and restart Netdata.

## Configuring Netdata Children

To enable streaming metrics to a Netdata Parent, [edit `stream.conf`](#edit-stream.conf), and at the `[stream]` section at the top, set:
To enable streaming metrics to a Netdata Parent, [edit `stream.conf`](#edit-streamconf), and at the `[stream]` section at the top, set:

```ini
[stream]
Expand Down
4 changes: 2 additions & 2 deletions packaging/installer/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ Go through our [deployment guides](https://github.com/netdata/netdata/blob/maste

By default, Netdata's installation scripts enable automatic updates for both nightly and stable release channels.

If you would prefer to update your Netdata agent manually, you can disable automatic updates by using the `--no-updates`
If you preferred to update your Netdata agent manually, you can disable automatic updates by using the `--no-updates`
option when you install or update Netdata using the [automatic one-line installation
script](#automatic-one-line-installation-script).
script](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md).

```bash
wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --no-updates
Expand Down
4 changes: 0 additions & 4 deletions packaging/installer/methods/macos.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,6 @@ Homebrew will place your Netdata configuration directory at `/opt/homebrew/etc/n

Use the `edit-config` script and the files in this directory to configure Netdata. For reference, you can find stock configuration files at `/opt/homebrew/Cellar/netdata/{NETDATA_VERSION}/lib/netdata/conf.d/`.



Skip on ahead to the [What's next?](#whats-next) section to find links to helpful post-installation guides.

## Install Netdata from source

We don't recommend installing Netdata from source on macOS, as it can be difficult to configure and install dependencies manually.
Expand Down
15 changes: 7 additions & 8 deletions src/web/gui/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,13 @@ behind an [Nginx proxy](https://github.com/netdata/netdata/blob/master/docs/netd

Beyond charts, the local dashboard can be broken down into three key areas:

- [Local Agent dashboard](#local-agent-dashboard)
- [Navigating the local dashboard](#navigating-the-local-dashboard)
- [Sections](#sections)
- [Time \& date picker](#time--date-picker)
- [Metrics menus](#metrics-menus)
- [Cloud menus (Spaces, War Rooms, and Visited nodes)](#cloud-menus-spaces-war-rooms-and-visited-nodes)
- [Customizing the local dashboard](#customizing-the-local-dashboard)
- [Custom dashboards](#custom-dashboards)
- [Navigating the local dashboard](#navigating-the-local-dashboard)
- [Sections](#sections)
- [Time \& date picker](#time--date-picker)
- [Metrics menus](#metrics-menus)
- [Cloud menus (Spaces, War Rooms, and Visited nodes)](#cloud-menus-spaces-war-rooms-and-visited-nodes)
- [Customizing the local dashboard](#customizing-the-local-dashboard)
- [Custom dashboards](#custom-dashboards)

![Annotated screenshot of the local Agent
dashboard](https://user-images.githubusercontent.com/1153921/101509403-f7e59400-3935-11eb-9abd-cbecfa3ee49a.png)
Expand Down

0 comments on commit b661732

Please sign in to comment.