diff options
author | Joel Hans <joel@netdata.cloud> | 2020-04-14 10:26:13 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-04-14 10:26:13 -0700 |
commit | e99692f145f710930723081d2e5bbf8868be2080 (patch) | |
tree | 468157463f0f133d927019e6826a9559dd989b9b /packaging/installer | |
parent | 59916b01b83026d6e6caf59f4efb67b7d428b70d (diff) |
Docs: Standardize links between documentation (#8638)
* Trying out some absolute-ish links
* Try one out on installer
* Testing logic
* Trying out some more links
* Fixing links
* Fix links in python collectors
* Changed a bunch more links
* Fix build errors
* Another push of links
* Fix build error and add more links
* Complete first pass
* Fix final broken links
* Fix links to files
* Fix for Netlify
* Two more fixes
Diffstat (limited to 'packaging/installer')
-rw-r--r-- | packaging/installer/README.md | 42 | ||||
-rw-r--r-- | packaging/installer/methods/kickstart-64.md | 21 |
2 files changed, 34 insertions, 29 deletions
diff --git a/packaging/installer/README.md b/packaging/installer/README.md index 708bffe824..044b65ef14 100644 --- a/packaging/installer/README.md +++ b/packaging/installer/README.md @@ -12,7 +12,8 @@ IoT/edge devices. Netdata runs on Linux, FreeBSD, macOS, Kubernetes, Docker, and The best way to install Netdata is with our [**automatic one-line installation script**](#automatic-one-line-installation-script), which works with all Linux distributions, or our [**.deb/rpm -packages**](methods/packages.md), which seamlessly install with your distribution's package manager. +packages**](/packaging/installer/methods/packages.md), which seamlessly install with your distribution's package +manager. If you want to install Netdata with Docker, on a Kubernetes cluster, or a different operating system, see [Have a different operating system, or want to try another @@ -23,7 +24,7 @@ packages. We recommend you install Netdata using one of the methods listed below checksum-verified packages. Starting with v1.12, Netdata collects anonymous usage information by default and sends it to Google Analytics. Read -about the information collected, and learn how to-opt, on our [anonymous statistics](../../docs/anonymous-statistics.md) +about the information collected, and learn how to-opt, on our [anonymous statistics](/docs/anonymous-statistics.md) page. The usage statistics are _vital_ for us, as we use them to discover bugs and prioritize new features. We thank you for @@ -42,21 +43,23 @@ bash <(curl -Ss https://my-netdata.io/kickstart.sh) ``` To see more information about this installation script, including how to disable automatic updates, get nightly vs. -stable releases, or disable anonymous statistics, see the [`kickstart.sh` method page](methods/kickstart.md). +stable releases, or disable anonymous statistics, see the [`kickstart.sh` method +page](/packaging/installer/methods/kickstart.md). Scroll down for details about [automatic updates](#automatic-updates) or [nightly vs. stable releases](#nightly-vs-stable-releases). -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. ## Have a different operating system, or want to try another method? Netdata works on many different operating systems, each with a few possible installation methods. To see the full list -of approved methods for each operating system/version we support, see our [distribution matrix](../DISTRIBUTIONS.md). +of approved methods for each operating system/version we support, see our [distribution +matrix](/packaging/DISTRIBUTIONS.md). Below, you can find a few additional installation methods, followed by separate instructions for a variety of unique operating systems. @@ -67,15 +70,15 @@ operating systems. [![Install with .deb or .rpm packages](https://user-images.githubusercontent.com/1153921/76029431-aebd6b00-5ef1-11ea-92b4-06704dabb93e.png) Install -with .deb or .rpm packages](methods/packages.md) +with .deb or .rpm packages](/packaging/installer/methods/packages.md) [![Install with a pre-built static binary for 64-bit systems](https://user-images.githubusercontent.com/1153921/73030303-94727680-3df6-11ea-963e-6f2cb0ce762c.png) Install -with a pre-built static binary for 64-bit systems](methods/kickstart-64.md) +with a pre-built static binary for 64-bit systems](/packaging/installer/methods/kickstart-64.md) [![Install Netdata on Docker](https://user-images.githubusercontent.com/1153921/76029355-85044400-5ef1-11ea-96f4-79edc58f9b5c.png) Install -Netdata on Docker](../docker/README.md) +Netdata on Docker](/packaging/docker/README.md) [![Install Netdata on Kubernetes](https://user-images.githubusercontent.com/1153921/76029478-cc8ad000-5ef1-11ea-8981-dd04744b00da.png) Install @@ -84,39 +87,39 @@ chart](https://github.com/netdata/helmchart#netdata-helm-chart-for-kubernetes-de [![Install Netdata on cloud providers (GCP/AWS/Azure)](https://user-images.githubusercontent.com/1153921/76029431-aebd6b00-5ef1-11ea-92b4-06704dabb93e.png) -Install Netdata on cloud providers (GCP/AWS/Azure)](methods/cloud-providers.md) +Install Netdata on cloud providers (GCP/AWS/Azure)](/packaging/installer/methods/cloud-providers.md) [![Install Netdata on macOS](https://user-images.githubusercontent.com/1153921/76029616-1673b600-5ef2-11ea-888a-4a1375a42246.png) Install -Netdata on macOS](methods/macos.md) +Netdata on macOS](/packaging/installer/methods/macos.md) [![Install Netdata on FreeBSD](https://user-images.githubusercontent.com/1153921/76029787-5fc40580-5ef2-11ea-9461-23e9049aa8f8.png) Install -Netdata on FreeBSD](methods/freebsd.md) +Netdata on FreeBSD](/packaging/installer/methods/freebsd.md) [![Install manually from source](https://user-images.githubusercontent.com/1153921/73032280-f1246000-3dfb-11ea-870d-7fbddd9a6f76.png) Install -manually from source](methods/manual.md) +manually from source](/packaging/installer/methods/manual.md) [![Install on offline/air-gapped systems](https://user-images.githubusercontent.com/1153921/73032239-c89c6600-3dfb-11ea-8224-c8a9f7a50c53.png) Install on -offline/air-gapped systems](methods/offline.md) +offline/air-gapped systems](/packaging/installer/methods/offline.md) [![Installation on PFSense](https://user-images.githubusercontent.com/1153921/76030071-cb0dd780-5ef2-11ea-87cd-607d943dc521.png) -Installation on PFSense](methods/pfsense.md) +Installation on PFSense](/packaging/installer/methods/pfsense.md) [![Install Netdata on Synology](https://user-images.githubusercontent.com/1153921/76029789-5fc40580-5ef2-11ea-9d35-c022f682da77.png) Install -Netdata on Synology](methods/synology.md) +Netdata on Synology](/packaging/installer/methods/synology.md) [![Manual installation on FreeNAS](https://user-images.githubusercontent.com/1153921/76030537-1c1dcb80-5ef3-11ea-9cf9-f130e7d41712.png) Manual -installation on FreeNAS](methods/freenas.md) +installation on FreeNAS](/packaging/installer/methods/freenas.md) [![Manual installation on Alpine](https://user-images.githubusercontent.com/1153921/76029682-37d4a200-5ef2-11ea-9a2c-a8ffeb1d13c3.png) Manual -installation on Alpine](methods/alpine.md) +installation on Alpine](/packaging/installer/methods/alpine.md) </div> @@ -132,7 +135,8 @@ script](#automatic-one-line-installation-script). bash <(curl -Ss https://my-netdata.io/kickstart.sh) --no-updates ``` -With automatic updates disabled, you can choose exactly when and how you [update Netdata](UPDATE.md). +With automatic updates disabled, you can choose exactly when and how you [update +Netdata](/packaging/installer/UPDATE.md). ## Nightly vs. stable releases diff --git a/packaging/installer/methods/kickstart-64.md b/packaging/installer/methods/kickstart-64.md index 74117214d1..f76708a535 100644 --- a/packaging/installer/methods/kickstart-64.md +++ b/packaging/installer/methods/kickstart-64.md @@ -22,8 +22,9 @@ bash <(curl -Ss https://my-netdata.io/kickstart-static64.sh) > This script installs Netdata at `/opt/netdata`. -> See our [installation guide](../README.md) for details about [automatic updates](../README.md#automatic-updates) or -> [nightly vs. stable releases](../README.md#nightly-vs-stable-releases). +> See our [installation guide](/packaging/installer/README.md) for details about [automatic +> updates](/packaging/installer/README.md#automatic-updates) or [nightly vs. stable +> releases](/packaging/installer/README.md#nightly-vs-stable-releases). ## What does `kickstart-static64.sh` do? @@ -61,13 +62,13 @@ your 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 - tarball, the checksum file, the go.d plugin tarball, and the go.d plugin config tarball, to force kickstart run the - process using those files. This option conflicts with the `--stable-channel` option. If you set this _and_ - `--stable-channel`, Netdata will use the local files. +- `--local-files`: Used for [offline installations](/packaging/installer/methods/offline.md). Pass four file paths: + the Netdata tarball, the checksum file, the go.d plugin tarball, and the go.d plugin config tarball, to force + kickstart run the process using those files. This option conflicts with the `--stable-channel` option. If you set + this _and_ `--stable-channel`, Netdata will use the local files. ## Verify script integrity @@ -82,8 +83,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) -for a fully-guided tour into Netdata's capabilities and how to configure it according to your needs. +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. |