diff options
author | Joel Hans <joel@netdata.cloud> | 2019-10-03 09:24:00 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-10-03 09:24:00 -0700 |
commit | 2cb939c3114de63836f40ee38373956afaebde35 (patch) | |
tree | 314d7237d796fb6b5a98003607477b9fe8ebdab5 /docs | |
parent | bfae683664b488df91940a81760459db2b18983c (diff) |
Fixing broken links found via linkchecker (#6983)
* Fixing links with workarounds and linkchecker
* A few linter fixes
Diffstat (limited to 'docs')
-rw-r--r-- | docs/contributing/contributing-documentation.md | 10 | ||||
-rw-r--r-- | docs/getting-started.md | 12 | ||||
-rw-r--r-- | docs/tutorials/longer-metrics-storage.md | 4 | ||||
-rw-r--r-- | docs/what-is-netdata.md | 12 |
4 files changed, 20 insertions, 18 deletions
diff --git a/docs/contributing/contributing-documentation.md b/docs/contributing/contributing-documentation.md index cd3dbc7ccd..6f94d5bf1d 100644 --- a/docs/contributing/contributing-documentation.md +++ b/docs/contributing/contributing-documentation.md @@ -19,7 +19,7 @@ followed by [Mastering Markdown](https://guides.github.com/features/mastering-ma There are two ways to contribute to Netdata's documentation: -1. Edit documentation [directly in GitHub](#edit-documentation-directly-on-gitHub). +1. Edit documentation [directly in GitHub](#edit-documentation-directly-on-github). 2. Download the repository and [edit documentation locally](#edit-documentation-locally). Editing in GitHub is a simpler process and is perfect for quick edits to a single document, @@ -45,7 +45,7 @@ Start editing documentation on GitHub by clicking the small pencil icon on any p You can find them at the top of every page. Clicking on this icon will take you to the associated page in the `netdata/netdata` repository. -Then click the small pencil icon on any documentation file (those ending in the `.md` [Markdown] extension) in the `netdata/netdata` repository. +Then click the small pencil icon on any documentation file (those ending in the `.md` Markdown extension) in the `netdata/netdata` repository. ![A screenshot of editing a Markdown file directly in the Netdata repository](https://user-images.githubusercontent.com/1153921/59637188-10426d00-910a-11e9-99f2-ec564d6fb7d5.png) @@ -109,7 +109,8 @@ folder and either name it `README.md` for generic documentation, or with another At the root of the Netdata repository is a `docs/` folder. Inside this folder we place documentation that does not have a direct relationship to a specific component of Netdata. It's where we house our [getting started -guide](../getting-started.md), guides on [running Netdata behind Nginx](../Running-behind-nginx.md), and more. +guide](../../docs/getting-started.md), guides on [running Netdata behind Nginx](../../docs/Running-behind-nginx.md), and +more. If the documentation you're working on doesn't have a direct relaionship to a component of Netdata, it can be placed in this `docs/` folder. @@ -168,7 +169,8 @@ cd docs/generator/build/ python3 -m http.server 20000 ``` -Feel free to replace the port number you want this web server to listen on (port `20000` in this case [only one higher than the agent!]). +Feel free to replace the port number you want this web server to listen on (port `20000` in this case (only one higher +than the agent!)). Open your web browser and navigate to `http://localhost:20000`. If you replaced the port earlier, change it here as well. diff --git a/docs/getting-started.md b/docs/getting-started.md index 86cc8920a2..ce35581920 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -167,7 +167,7 @@ There are two quick ways to increase the depth of historical metrics: increase t that's enabled by default, or switch to the database engine. We have a tutorial that walks you through both options: [**Changing how long Netdata stores -metrics**](tutorials/longer-metrics-storage.md). +metrics**](../docs/tutorials/longer-metrics-storage.md). **What's next?**: @@ -181,9 +181,9 @@ metrics**](tutorials/longer-metrics-storage.md). If you have Netdata installed on multiple systems, you can have them all appear in the **My nodes** menu at the top-left corner of the dashboard. -To show all your servers in that menu, you need to [register for or sign in](netdata-cloud/signing-in.md) to [Netdata -Cloud](netdata-cloud/) from each system. Each system will then appear in the **My nodes** menu, which you can use to -navigate between your systems quickly. +To show all your servers in that menu, you need to [register for or sign in](../docs/netdata-cloud/signing-in.md) to +[Netdata Cloud](../docs/netdata-cloud/) from each system. Each system will then appear in the **My nodes** menu, which +you can use to navigate between your systems quickly. ![Animated GIF of the My Nodes menu in action](https://user-images.githubusercontent.com/1153921/64389938-9aa7b800-cff9-11e9-9653-a77e791811ad.gif) @@ -198,7 +198,7 @@ You can now seamlessly track performance anomalies across your entire infrastruc - Read up on how the [Netdata Cloud registry works](../registry/), and what kind of data it stores and sends to your web browser. -- Familiarize yourself with the [Nodes View](netdata-cloud/nodes-view.md) +- Familiarize yourself with the [Nodes View](../docs/netdata-cloud/nodes-view.md) ## Start, stop, and restart Netdata @@ -228,6 +228,6 @@ Take a look at some more advanced features and configurations: - Improve security by putting Netdata behind an [Nginx proxy with SSL](Running-behind-nginx.md). Or, learn more about how you can contribute to [Netdata core](../CONTRIBUTING.md) or our -[documentation](contributing/contributing-documentation.md)! +[documentation](../docs/contributing/contributing-documentation.md)! [![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdocs%2FGettingStarted&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>) diff --git a/docs/tutorials/longer-metrics-storage.md b/docs/tutorials/longer-metrics-storage.md index 1a2a78b9a3..e227f5bda7 100644 --- a/docs/tutorials/longer-metrics-storage.md +++ b/docs/tutorials/longer-metrics-storage.md @@ -151,5 +151,5 @@ probably want to see it in action! For more information about how to pan charts to view historical metrics, see our documentation on [using charts](../../web/README.md#using-charts). -And if you'd now like to reduce Netdata's resource usage, view our [performance guide](../Performance.md) for our best -practices on optimization. +And if you'd now like to reduce Netdata's resource usage, view our [performance guide](../../docs/Performance.md) for +our best practices on optimization. diff --git a/docs/what-is-netdata.md b/docs/what-is-netdata.md index b134dc2ca9..e9b4d1598f 100644 --- a/docs/what-is-netdata.md +++ b/docs/what-is-netdata.md @@ -43,7 +43,7 @@ We provide docker images for the most common architectures. These are statistics ### Registry -When you install multiple Netdata, they are integrated into **one distributed application**, via a [Netdata registry](../registry/#registry). This is a web browser feature and it allows us to count the number of unique users and unique Netdata servers installed. The following information comes from the global public Netdata registry we run: +When you install multiple Netdata, they are integrated into **one distributed application**, via a [Netdata registry](../registry/). This is a web browser feature and it allows us to count the number of unique users and unique Netdata servers installed. The following information comes from the global public Netdata registry we run: [![User Base](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&label=user%20base&units=M&value_color=blue&precision=2÷=1000000&v43)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![Monitored Servers](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=machines&label=servers%20monitored&units=k÷=1000&value_color=orange&precision=2&v43)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![Sessions Served](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_sessions&label=sessions%20served&units=M&value_color=yellowgreen&precision=2÷=1000000&v43)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) @@ -91,12 +91,12 @@ This is how it works: |Function|Description|Documentation| |:------:|:----------|:-----------:| -|**Collect**|Multiple independent data collection workers are collecting metrics from their sources using the optimal protocol for each application and push the metrics to the database. Each data collection worker has lockless write access to the metrics it collects.|[`collectors`](../collectors/#data-collection-plugins)| -|**Store**|Metrics are stored in RAM in a round robin database (ring buffer), using a custom made floating point number for minimal footprint.|[`database`](../database/#database)| -|**Check**|A lockless independent watchdog is evaluating **health checks** on the collected metrics, triggers alarms, maintains a health transaction log and dispatches alarm notifications.|[`health`](../health/#health-monitoring)| -|**Stream**|An lockless independent worker is streaming metrics, in full detail and in real-time, to remote Netdata servers, as soon as they are collected.|[`streaming`](../streaming/#streaming-and-replication)| +|**Collect**|Multiple independent data collection workers are collecting metrics from their sources using the optimal protocol for each application and push the metrics to the database. Each data collection worker has lockless write access to the metrics it collects.|[`collectors`](../collectors/)| +|**Store**|Metrics are stored in RAM in a round robin database (ring buffer), using a custom made floating point number for minimal footprint.|[`database`](../database/)| +|**Check**|A lockless independent watchdog is evaluating **health checks** on the collected metrics, triggers alarms, maintains a health transaction log and dispatches alarm notifications.|[`health`](../health/)| +|**Stream**|An lockless independent worker is streaming metrics, in full detail and in real-time, to remote Netdata servers, as soon as they are collected.|[`streaming`](../streaming/)| |**Archive**|A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases.|[`backends`](../backends/)| -|**Query**|Multiple independent workers are attached to the [internal web server](../web/server/#web-server), servicing API requests, including [data queries](../web/api/queries/#database-queries).|[`web/api`](../web/api/#api)| +|**Query**|Multiple independent workers are attached to the [internal web server](../web/server/), servicing API requests, including [data queries](../web/api/queries/README.md).|[`web/api`](../web/api/)| The result is a highly efficient, low latency system, supporting multiple readers and one writer on each metric. |