diff options
| author | Joel Hans <joel@netdata.cloud> | 2020-05-11 08:48:23 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-11 08:48:23 -0700 |
| commit | 74fda3de8e45e4211da8a574daabbfc30c74f0a9 (patch) | |
| tree | bcb5fb2a9ce32f759ca7bb139fb6e9da70e2126e | |
| parent | 9e8a0e173e2f4402fb081950b4b25d5fc0b62492 (diff) | |
Docs: Fix internal links and remove obsolete admonitions (#8946)
* Fixed a few more links
* Remove old syntax
* Abs-relative links to files in docs folder
* Trying to fix nother doc learn link
* Fix a few more links
* Add testing doc
* Tracking down mysteries
* Cleanup
* Update broken external links
* Remove index.html that appeared from testing
* Fix remainder of links
27 files changed, 87 insertions, 87 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 41827a5d2a..3037c2a017 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -75,7 +75,7 @@ Our documentation is in need of constant improvement and expansion. As Netdata's We also need to produce beginner-level tutorials on using Netdata to monitor common applications, web servers, and more. -Start with the [guide for contributing to documentation](docs/contributing/contributing-documentation.md), and then review the [documentation style guide](docs/contributing/style-guide.md) for specifics on how we write our documentation. +Start with the [guide for contributing to documentation](/docs/contributing/contributing-documentation.md), and then review the [documentation style guide](/docs/contributing/style-guide.md) for specifics on how we write our documentation. Don't be afraid to submit a pull request with your corrections or additions! We need a lot of help and are willing to guide new contributors through the process. diff --git a/aclk/README.md b/aclk/README.md index e5529dd52c..852d7b43dc 100644 --- a/aclk/README.md +++ b/aclk/README.md @@ -99,7 +99,7 @@ reinstall Netdata with Cloud enabled or change the runtime setting in your `clou If you passed `--disable-cloud` to `netdata-installer.sh` during installation, you must reinstall your Agent. Use the same method as before, but pass `--require-cloud` to the installer. When installation finishes you can [claim your -node](/claim/README.md#claim-a-node). +node](/claim/README.md#how-to-claim-a-node). If you changed the runtime setting in your `var/lib/netdata/cloud.d/cloud.conf` file, edit the file again and change `enabled` to `yes`: @@ -109,6 +109,6 @@ If you changed the runtime setting in your `var/lib/netdata/cloud.d/cloud.conf` enabled = yes ``` -Restart your Agent and [claim your node](/claim/README.md#claim-a-node). +Restart your Agent and [claim your node](/claim/README.md#how-to-claim-a-node). [](<>) diff --git a/collectors/QUICKSTART.md b/collectors/QUICKSTART.md index 6a13023296..9a4fdbebab 100644 --- a/collectors/QUICKSTART.md +++ b/collectors/QUICKSTART.md @@ -82,7 +82,7 @@ Despite Netdata's auto-detection capabilities, it's important to know how to edi You should always edit configuration files with the `edit-config` script that comes with every installation of Netdata. To edit a collector configuration file, navigate to your [Netdata configuration -directory](../docs/step-by-step/step-04.md#find-your-netdataconf-file). Launch `edit-config` with the path to the +directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file). Launch `edit-config` with the path to the collector's configuration file. How do you find that path to the collector's configuration file? Look under the **Configuration** heading in the @@ -105,7 +105,7 @@ Most collectors are enabled and will auto-detect their app/service without manua restart Netdata to trigger the auto-detection process. To restart Netdata on most systems, use `service netdata restart`. For other systems, see the [other restart -methods](../docs/getting-started.md#start-stop-and-restart-netdata). +methods](/docs/getting-started.md#start-stop-and-restart-netdata). Open Netdata's dashboard in your browser, or refresh the page if you already have it open. You should now see a new entry in the menu and new interactive charts! diff --git a/collectors/freeipmi.plugin/README.md b/collectors/freeipmi.plugin/README.md index 799d46d1c9..7ea57ed8ac 100644 --- a/collectors/freeipmi.plugin/README.md +++ b/collectors/freeipmi.plugin/README.md @@ -163,13 +163,8 @@ You will get verbose output on what the plugin does. ## kipmi0 CPU usage -There have been reports that kipmi is showing increased CPU when the IPMI is queried. - -[IBM has given a few explanations](http://www-01.ibm.com/support/docview.wss?uid=nas7d580df3d15874988862575fa0050f604). - -Check also [this stackexchange post](http://unix.stackexchange.com/questions/74900/kipmi0-eating-up-to-99-8-cpu-on-centos-6-4). - -To lower the CPU consumption of the system you can issue this command: +There have been reports that kipmi is showing increased CPU when the IPMI is queried. To lower the CPU consumption of +the system you can issue this command: ```sh echo 10 > /sys/module/ipmi_si/parameters/kipmid_max_busy_us diff --git a/collectors/python.d.plugin/oracledb/README.md b/collectors/python.d.plugin/oracledb/README.md index ca9ee6901f..dbe6505e63 100644 --- a/collectors/python.d.plugin/oracledb/README.md +++ b/collectors/python.d.plugin/oracledb/README.md @@ -46,9 +46,10 @@ It produces following charts: To use the Oracle module do the following: -1. Install `cx_Oracle` package ([link](https://cx-oracle.readthedocs.io/en/latest/installation.html#install-cx-oracle)). +1. Install `cx_Oracle` package ([link](https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html)). -2. Install Oracle Client libraries ([link](https://cx-oracle.readthedocs.io/en/latest/installation.html#install-oracle-client)). +2. Install Oracle Client libraries + ([link](https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html#install-oracle-client)). 3. Create a read-only `netdata` user with proper access to your Oracle Database Server. diff --git a/docs/Donations-netdata-has-received.md b/docs/Donations-netdata-has-received.md index 588229378f..2c75b87436 100644 --- a/docs/Donations-netdata-has-received.md +++ b/docs/Donations-netdata-has-received.md @@ -18,7 +18,6 @@ This is a list of the donations we have received for Netdata (sorted alphabetica | Cloud VMs|[london.my-netdata.io](https://london.my-netdata.io) (Several VMs)|**[DigitalOcean.com](https://www.digitalocean.com/)**|**DigitalOcean.com** donated 1000 USD to be used in their excellent Cloud Computing services. Many thanks to [Justin Paine](https://github.com/xxdesmus) for making this happen.| | Development IDE|-|**[JetBrains.com](https://www.jetbrains.com/)**|**JetBrains.com** donated an open source license for 4 developers for 1 year, to their excellent IDEs.| | Cloud VM|[octopuscs.my-netdata.io](https://octopuscs.my-netdata.io)|**[OctopusCS.com](https://octopuscs.com/)**|**OctopusCS.com** donated a VM with 4 CPU cores, 16GB RAM and 50GB HD in their excellent Cloud Computing services.| -| Cloud VM|[ventureer.my-netdata.io](https://ventureer.my-netdata.io)|**[Ventureer.com](https://ventureer.com/)**|**Ventureer.com** donated a VM with 4 CPU cores, 8GB RAM and 50GB HD in their excellent Cloud Computing services.| | Cloud VM|[stackscale.my-netdata.io](https://stackscale.my-netdata.io)|**[stackscale.com](https://www.stackscale.com/)**|**StackScale.com** donated a VM with 4 CPU cores, 16GB RAM and 100GB HD in their excellent Cloud Computing services.| Thank you! diff --git a/docs/Running-behind-haproxy.md b/docs/Running-behind-haproxy.md index 28e7761563..bf6ae76a12 100644 --- a/docs/Running-behind-haproxy.md +++ b/docs/Running-behind-haproxy.md @@ -11,9 +11,10 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-beh > and proxying for TCP and HTTP-based applications. It is particularly suited for very high traffic web sites > and powers quite a number of the world's most visited ones. -If Netdata is running on a host running HAProxy, rather than connecting to Netdata from a port number, a domain name -can be pointed at HAProxy, and HAProxy can redirect connections to the Netdata port. This can make it possible to -connect to Netdata at <https://example.com> or <https://example.com/netdata/>, which is a much nicer experience then <http://example.com:19999>. +If Netdata is running on a host running HAProxy, rather than connecting to Netdata from a port number, a domain name can +be pointed at HAProxy, and HAProxy can redirect connections to the Netdata port. This can make it possible to connect to +Netdata at `https://example.com` or `https://example.com/netdata/`, which is a much nicer experience then +`http://example.com:19999`. To proxy requests from [HAProxy](https://github.com/haproxy/haproxy) to Netdata, the following configuration can be used: @@ -29,7 +30,7 @@ defaults ## Simple Configuration -A simple example where the base URL, say <http://example.com>, is used with no subpath: +A simple example where the base URL, say `http://example.com`, is used with no subpath: ### Frontend diff --git a/docs/anonymous-statistics.md b/docs/anonymous-statistics.md index 46bf06bcec..71c995a519 100644 --- a/docs/anonymous-statistics.md +++ b/docs/anonymous-statistics.md @@ -97,7 +97,7 @@ update. You can also export the environment variable `DO_NOT_TRACK` with a non-z When using Docker, **set your `DO_NOT_TRACK` environment variable to `1`.** You can set this variable with the following command: `export DO_NOT_TRACK=1`. When creating a container using Netdata's [Docker -image](/packaging/docker/README.md#run-netdata-with-the-docker-command) for the first time, this variable will disable +image](/packaging/docker/README.md#run-the-agent-with-the-docker-command) for the first time, this variable will disable the anonymous statistics script inside of the container. Each of these opt-out processes does the following: diff --git a/docs/contributing/contributing-documentation.md b/docs/contributing/contributing-documentation.md index 9347bccabc..b3ee12025d 100644 --- a/docs/contributing/contributing-documentation.md +++ b/docs/contributing/contributing-documentation.md @@ -1,8 +1,6 @@ <!-- ---- title: "Contributing to documentation" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/contributing/contributing-documentation.md ---- --> # Contributing to documentation @@ -70,9 +68,9 @@ button. After you've hit that button, jump down to our instructions on [pull requests and cleanup](#pull-requests-and-final-steps) for your next steps. -!!! note This process will create a branch directly on the `netdata/netdata` repository, which then requires manual - cleanup. If you're going to make significant documentation contributions, or contribute often, we recommend the - local editing process just below. +> This process will create a branch directly on the `netdata/netdata` repository, which then requires manual cleanup. If +> you're going to make significant documentation contributions, or contribute often, we recommend the local editing +> process just below. ## Edit documentation locally @@ -115,8 +113,7 @@ folder and either name it `README.md` for generic documentation, or with another #### The `docs` folder 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](/docs/getting-started.md), guides on [running Netdata behind Nginx](/docs/Running-behind-nginx.md), and more. +a direct relationship to a specific component of Netdata. 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. diff --git a/docs/contributing/style-guide.md b/docs/contributing/style-guide.md index 6ff684e406..72f93b0fd9 100644 --- a/docs/contributing/style-guide.md +++ b/docs/contributing/style-guide.md @@ -1,8 +1,6 @@ <!-- ---- title: "Netdata style guide" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/contributing/style-guide.md ---- --> # Netdata style guide @@ -112,12 +110,12 @@ Conciseness leads to more accurate and understandable writing. Hyperlinks should clearly state its destination. Don't use words like "here" to describe where a link will take your reader. -``` +```markdown # Not recommended -To install Netdata, click [here](https://docs.netdata.cloud/packaging/installer/). +To install Netdata, click [here](/packaging/installer/README.md). # Recommended -To install Netdata, read our [installation instructions](https://docs.netdata.cloud/packaging/installer/). +To install Netdata, read our [installation instructions](/packaging/installer/README.md). ``` In general, guides should include fewer hyperlinks to keep the reader focused on the task at hand. Documentation should @@ -321,8 +319,8 @@ reference the label text of the link/button with Markdown's (`**bold text**`) ta Click on the **Sign in** button. ``` -!!! note Whenever possible, avoid using directional language to orient readers, because not every reader can use - instructions like "look at the top-left corner" to find their way around an interface. +> Whenever possible, avoid using directional language to orient readers, because not every reader can use instructions +> like "look at the top-left corner" to find their way around an interface. If you feel that you must use directional language, perhaps use an [image](#images) (with proper alt text) instead. @@ -370,8 +368,8 @@ Display line numbers by appending `linenums="1"` after the language declaration, number of your choice. Highlight lines by appending `hl_lines="2"`, replacing `2` with the line you'd like to highlight. Or, multiple lines: `hl_lines="1 2 4 12`. -!!! note Line numbers and highlights are not compatible with GitHub's Markdown parser, and thus will only be viewable on - our [documentation site](https://docs.netdata.cloud/). They should be used sparingly and only when necessary. +> Line numbers and highlights are not compatible with GitHub's Markdown parser, and thus will only be viewable on our +> [documentation site](https://learn.netdata.cloud/). They should be used sparingly and only when necessary. ## Accessibility diff --git a/docs/tutorials/collect-apache-nginx-web-logs.md b/docs/tutorials/collect-apache-nginx-web-logs.md index d797cf1960..0afa9189d3 100644 --- a/docs/tutorials/collect-apache-nginx-web-logs.md +++ b/docs/tutorials/collect-apache-nginx-web-logs.md @@ -130,8 +130,9 @@ web server's access log and begin showing real-time charts! The web log collector is capable of parsing custom Nginx and Apache log formats and presenting them as charts, but we'll leave that topic for a separate tutorial. -We do have [extensive documentation](/collectors/go.d.plugin/modules/weblog/README.md#custom-log-format) on how to build -custom parsing for Nginx and Apache logs. +We do have [extensive +documentation](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog/#custom-log-format) on how +to build custom parsing for Nginx and Apache logs. ## Tweak web log collector alarms @@ -153,8 +154,8 @@ documentation](/health/README.md). ## What's next? Now that you have web log collection up and running, we recommend you take a look at the documentation for our -[python.d](/collectors/python.d.plugin/web_log/README.md) for some ideas of how you can turn these rather "boring" -logs into powerful real-time tools for keeping your servers happy. +[python.d](/collectors/python.d.plugin/web_log/README.md) for some ideas of how you can turn these rather "boring" logs +into powerful real-time tools for keeping your servers happy. Don't forget to give GitHub user [Wing924](https://github.com/Wing924) a big 👍 for his hard work in starting up the Go refactoring effort. diff --git a/docs/tutorials/monitor-cockroachdb.md b/docs/tutorials/monitor-cockroachdb.md index e4c54fffaa..43d9cf2c65 100644 --- a/docs/tutorials/monitor-cockroachdb.md +++ b/docs/tutorials/monitor-cockroachdb.md @@ -9,7 +9,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/tutorials/m [CockroachDB](https://github.com/cockroachdb/cockroach) is an open-source project that brings SQL databases into scalable, disaster-resilient cloud deployments. Thanks to a [new CockroachDB -collector](https://docs.netdata.cloud/collectors/go.d.plugin/modules/cockroachdb/) released in +collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/cockroachdb/) released in [v1.20](https://blog.netdata.cloud/posts/release-1.20/), you can now monitor any number of CockroachDB databases with maximum granularity using Netdata. Collect more than 50 unique metrics and put them on interactive visualizations designed for better visual anomaly detection. @@ -122,7 +122,8 @@ thoughts. Also, be sure to check out these useful resources: -- [Netdata's CockroachDB documentation](https://docs.netdata.cloud/collectors/go.d.plugin/modules/cockroachdb/) +- [Netdata's CockroachDB + documentation](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/cockroachdb/) - [Netdata's CockroachDB configuration](https://github.com/netdata/go.d.plugin/blob/master/config/go.d/cockroachdb.conf) - [Netdata's CockroachDB diff --git a/health/QUICKSTART.md b/health/QUICKSTART.md index 05e78df91c..57baa7ea04 100644 --- a/health/QUICKSTART.md +++ b/health/QUICKSTART.md @@ -37,7 +37,7 @@ cd /etc/netdata/ # Replace with your Netdata configuration directory, if not /et > You may need to use `sudo` or another method of elevating your privileges: `sudo ./edit-config health.d/cpu.conf`. > > You can also use the `$EDITOR` environment variable to use your preferred terminal editor with `edit-config`. See -> [this page](../docs/step-by-step/step-04.md#use-edit-config-to-open-netdataconf) for details. +> [this page](/docs/step-by-step/step-04.md#use-edit-config-to-open-netdataconf) for details. Each health configuration file contains one or more health entities, which always begin with an `alarm:` or `template:` line. You can edit these entities based on your needs. To make any changes live, be sure to [reload your health diff --git a/health/REFERENCE.md b/health/REFERENCE.md index 9a53ce6b30..2b4b313b36 100644 --- a/health/REFERENCE.md +++ b/health/REFERENCE.md @@ -382,7 +382,7 @@ good idea to tell Netdata to not clear the notification, by using the `no-clear- #### Alarm line `host labels` -Defines the list of labels present on a host. See our [host labels tutorial](../docs/tutorials/using-host-labels.md) for +Defines the list of labels present on a host. See our [host labels tutorial](/docs/tutorials/using-host-labels.md) for an explanation of host labels and how to implement them. For example, let's suppose that `netdata.conf` is configured with the following labels: diff --git a/health/notifications/awssns/README.md b/health/notifications/awssns/README.md index a2ff6deee6..0ec785bc60 100644 --- a/health/notifications/awssns/README.md +++ b/health/notifications/awssns/README.md @@ -20,7 +20,9 @@ To get this working, you will need: - The Amazon Web Services CLI tools. Most distributions provide these with the package name `awscli`. - An actual home directory for the user you run Netdata as, instead of just using `/` as a home directory. Setup of this is distribution specific. `/var/lib/netdata` is the recommended directory (because the permissions will already be correct) if you are using a dedicated user (which is how most distributions work). -- An Amazon SNS topic to send notifications to with one or more subscribers. The [Getting Started](https://docs.aws.amazon.com/sns/latest/dg/GettingStarted.html) section of the Amazon SNS documentation covers the basics of how to set this up. Make note of the Topic ARN when you create the topic. +- An Amazon SNS topic to send notifications to with one or more subscribers. The [Getting + Started](https://docs.aws.amazon.com/sns/latest/dg/sns-getting-started.html) section of the Amazon SNS documentation + covers the basics of how to set this up. Make note of the Topic ARN when you create the topic. - While not mandatory, it is highly recommended to create a dedicated IAM user on your account for Netdata to send notifications. This user needs to have programmatic access, and should only allow access to SNS. If you're really paranoid, you can create one for each system or group of systems. Once you have all the above, run the following command as the user Netdata runs under: diff --git a/health/notifications/dynatrace/README.md b/health/notifications/dynatrace/README.md index 3532968f05..3f8ad85b6d 100644 --- a/health/notifications/dynatrace/README.md +++ b/health/notifications/dynatrace/README.md @@ -1,8 +1,6 @@ <!-- ---- title: "Dynatrace" custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/dynatrace/README.md ---- --> # Dynatrace @@ -22,10 +20,10 @@ This is a required parameter. Generate a Dynatrace API authentication token. On your Dynatrace server, go to **Settings** --> **Integration** --> **Dynatrace API** --> **Generate token**. See [Dynatrace API - Authentication](https://www.dynatrace.com/support/help/extend-dynatrace/dynatrace-api/basics/dynatrace-api-authentication/) for more details. This is a required parameter. -3. API Space. This is the URL part of the page you have access in order to generate the API Token. For example, for my generated API Token the URL is: -https://monitor.illumineit.com/e/2a93fe0e-4cd5-469a-9d0d-1a064235cfce/#settings/integration/apikeys;gf=all -In that case, my space is _2a93fe0e-4cd5-469a-9d0d-1a064235cfce_ -This is a required parameter. +3. API Space. This is the URL part of the page you have access in order to generate the API Token. For example, the URL + for a generated API token might look like: + `https://monitor.illumineit.com/e/2a93fe0e-4cd5-469a-9d0d-1a064235cfce/#settings/integration/apikeys;gf=all` In that + case, my space is _2a93fe0e-4cd5-469a-9d0d-1a064235cfce_ This is a required parameter. 4. Generate a Server Tag. On your Dynatrace Server, go to **Settings** --> **Tags** --> **Manually applied tags** and create the Tag. The Netdata alarm is sent as a Dynatrace Event to be correlated with all those hosts tagged with this Tag you have created. This is a required parameter. diff --git a/health/notifications/kavenegar/README.md b/health/notifications/kavenegar/README.md index e1e63fdfa4..4d43c450ee 100644 --- a/health/notifications/kavenegar/README.md +++ b/health/notifications/kavenegar/README.md @@ -7,7 +7,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notificat # Kavenegar -[Kavenegar](https://www.kavenegar.com/) as service for software developers, based in Iran, provides send and receive SMS, calling voice by using its APIs. +[Kavenegar](https://kavenegar.com/) as service for software developers, based in Iran, provides send and receive SMS, calling voice by using its APIs. Will look like this on your Android device: diff --git a/packaging/installer/UPDATE.md b/packaging/installer/UPDATE.md index c5f56275f9..e398be13d8 100644 --- a/packaging/installer/UPDATE.md +++ b/packaging/installer/UPDATE.md @@ -95,8 +95,9 @@ First, pull the latest version of the image. docker pull netdata/netdata:latest ``` -Next, to stop and remove any containers using the `netdata/netdata` image. Replace `netdata` if you changed -it from the default in our [Docker installation instructions](../docker/README.md#run-netdata-with-the-docker-command). +Next, to stop and remove any containers using the `netdata/netdata` image. Replace `netdata` if you changed it from the +default in our [Docker installation +instructions](/packaging/docker/README.md#run-the-agent-with-the-docker-command). ```bash docker stop netdata @@ -104,8 +105,8 @@ docker rm netdata ``` You can now re-create your Netdata container using the `docker` command or a `docker-compose.yml` file. See our [Docker -installation instructions](../docker/README.md#run-netdata-with-the-docker-command) for details. For example, using the -`docker` command: +installation instructions](/packaging/docker/README.md#run-the-agent-with-the-docker-command) for details. For +example, using the `docker` command: ```bash docker run -d --name=netdata \ diff --git a/packaging/installer/methods/cloud-providers.md b/packaging/installer/methods/cloud-providers.md index 457a4d015a..90989548b3 100644 --- a/packaging/installer/methods/cloud-providers.md +++ b/packaging/installer/methods/cloud-providers.md @@ -58,11 +58,11 @@ command from a remote system, and it fails, it's likely that a firewall is block Another option is to put Netdata behind web server, which will proxy requests through standard HTTP/HTTPS ports (80/443), which are likely already open on your instance. We have a number of guides available: -- [Apache](../../../docs/Running-behind-apache.md) -- [Nginx](../../../docs/Running-behind-nginx.md) -- [Caddy](../../../docs/Running-behind-caddy.md) -- [HAProxy](../../../docs/Running-behind-haproxy.md) -- [lighttpd](../../../docs/Running-behind-lighttpd.md) +- [Apache](/docs/Running-behind-apache.md) +- [Nginx](/docs/Running-behind-nginx.md) +- [Caddy](/docs/Running-behind-caddy.md) +- [HAProxy](/docs/Running-behind-haproxy.md) +- [lighttpd](/docs/Running-behind-lighttpd.md) The next few sections outline how to add firewall rules to GCP, AWS, and Azure instances. diff --git a/packaging/installer/methods/kickstart.md b/packaging/installer/methods/kickstart.md index cd3c138654..528c7c50b2 100644 --- a/packaging/installer/methods/kickstart.md +++ b/packaging/installer/methods/kickstart.md @@ -44,7 +44,7 @@ installation. Here are a few important parameters: - `--dont-start-it`: Prevent the installer from starting Netdata automatically. - `--stable-channel`: Automatically update only on the release of new major versions. - `--nightly-channel`: Automatically update on every new nightly build. -- `--disable-telemetry`: Opt-out of [anonymous statistics](../../../docs/anonymous-statistics.md) we use to make +- `--disable-telemetry`: Opt-out of [anonymous statistics](/docs/anonymous-statistics.md) we use to make Netdata better. - `--no-updates`: Prevent automatic updates of any kind. - `--local-files`: Used for [offline installations](offline.md). Pass four file paths: the Netdata @@ -65,8 +65,8 @@ If the script is valid, this command will return `OK, VALID`. ## What's next? -When you finish installing Netdata, be sure to visit our [step-by-step tutorial](../../../docs/step-by-step/step-00.md) +When you finish installing Netdata, be sure to visit our [step-by-step tutorial](/docs/step-by-step/step-00.md) for a fully-guided tour into Netdata's capabilities and how to configure it according to your needs. Or, if you're a monitoring and system administration pro, skip ahead to our [getting started -guide](../../../docs/getting-started.md) for a quick overview. +guide](/docs/getting-started.md) for a quick overview. diff --git a/packaging/installer/methods/macos.md b/packaging/installer/methods/macos.md index d51ffccf23..9e073f509e 100644 --- a/packaging/installer/methods/macos.md +++ b/packaging/installer/methods/macos.md @@ -56,7 +56,7 @@ to install some of Netdata's prerequisites. brew install ossp-uuid autoconf automake pkg-config libuv lz4 json-c openssl@1.1 ``` -If you want to use the [database engine](../../../database/engine/README.md) to store your metrics, you need to download +If you want to use the [database engine](/database/engine/README.md) to store your metrics, you need to download and install the [Judy library](https://sourceforge.net/projects/judy/) before proceeding compiling Netdata. Next, download Netdata from our GitHub repository: @@ -79,8 +79,8 @@ sudo ./netdata-installer.sh --install /usr/local ## What's next? -When you finish installing Netdata, be sure to visit our [step-by-step tutorial](../../../docs/step-by-step/step-00.md) +When you finish installing Netdata, be sure to visit our [step-by-step tutorial](/docs/step-by-step/step-00.md) for a fully-guided tour into Netdata's capabilities and how to configure it according to your needs. Or, if you're a monitoring and system administration pro, skip ahead to our [getting started -guide](../../../docs/getting-started.md) for a quick overview. +guide](/docs/getting-started.md) for a quick overview. diff --git a/packaging/installer/methods/manual.md b/packaging/installer/methods/manual.md index fdcabaf89d..7aa9a7be24 100644 --- a/packaging/installer/methods/manual.md +++ b/packaging/installer/methods/manual.md @@ -216,8 +216,8 @@ In most cases, you can do this by running `CC=gcc ./netdata-installer.sh`. ## What's next? -When you finish installing Netdata, be sure to visit our [step-by-step tutorial](../../../docs/step-by-step/step-00.md) +When you finish installing Netdata, be sure to visit our [step-by-step tutorial](/docs/step-by-step/step-00.md) for a fully-guided tour into Netdata's capabilities and how to configure it according to your needs. Or, if you're a monitoring and system administration pro, skip ahead to our [getting started -guide](../../../docs/getting-started.md) for a quick overview. +guide](/docs/getting-started.md) for a quick overview. diff --git a/packaging/installer/methods/offline.md b/packaging/installer/methods/offline.md index adb829d139..dab7650737 100644 --- a/packaging/installer/methods/offline.md +++ b/packaging/installer/methods/offline.md @@ -76,8 +76,8 @@ bash kickstart.sh --local-files /tmp/netdata-(version-number-here).tar.gz /tmp/s bash kickstart-static64.sh --local-files /tmp/netdata-(version-number-here).gz.run /tmp/sha256sums.txt ``` -Now that Netdata is installed, be sure to visit our [getting started guide](../../../docs/getting-started.md) for a +Now that Netdata is installed, be sure to visit our [getting started guide](/docs/getting-started.md) for a |