Browse Source

Docs lint on `packaging/` dir (#18665)

* docker readme pass

* installer/methods docs pass

* installer/ docs pass

* maintainers dir docs pass

* rest of packaging dir md docs pass
Fotis Voutsas 5 months ago
parent
commit
1ddbc6610d

+ 40 - 52
packaging/PLATFORM_SUPPORT.md

@@ -1,14 +1,3 @@
-<!--
-title: "Platform support policy"
-sidebar_label: "Platform support policy"
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/PLATFORM_SUPPORT.md"
-learn_status: "Published"
-sidebar_position: "1"
-learn_topic_type: "Tasks"
-learn_rel_path: "Installation"
-learn_docs_purpose: "Present all the supported platform in the Netdata solution"
--->
-
 # Platform support policy
 
 Netdata defines three tiers of official support:
@@ -30,13 +19,13 @@ Any platforms not listed in any of these categories may or may not work.
 
 The following table shows a general outline of the various support tiers and categories.
 
-|   | Bug Support | Guaranteed Configurations | CI Coverage | Native Packages | Static Build Support |
-| - | ----------- | ------------------------- | ----------- | --------------- | -------------------- |
-| Core | High priority | Everything but rare edge cases | Full | Yes, if we can provide them | Full |
-| Intermediate | Normal priority | Common cases | Partial (CI mostly equivalent to **Core**, but possibly with some gaps, and not required to pass) | Possibly | Full |
-| Community | Best Effort | Default only | None | No | Best Effort |
-| Third-party Supported | Users directed to platform maintainers | None | None | No | Best Effort |
-| Previously Supported | Users asked to upgrade | None | None | Yes, but only already published versions | Best Effort |
+|                       | Bug Support                            | Guaranteed Configurations      | CI Coverage                                                                                       | Native Packages                          | Static Build Support |
+|-----------------------|----------------------------------------|--------------------------------|---------------------------------------------------------------------------------------------------|------------------------------------------|----------------------|
+| Core                  | High priority                          | Everything but rare edge cases | Full                                                                                              | Yes, if we can provide them              | Full                 |
+| Intermediate          | Normal priority                        | Common cases                   | Partial (CI mostly equivalent to **Core**, but possibly with some gaps, and not required to pass) | Possibly                                 | Full                 |
+| Community             | Best Effort                            | Default only                   | None                                                                                              | No                                       | Best Effort          |
+| Third-party Supported | Users directed to platform maintainers | None                           | None                                                                                              | No                                       | Best Effort          |
+| Previously Supported  | Users asked to upgrade                 | None                           | None                                                                                              | Yes, but only already published versions | Best Effort          |
 
 - ‘Bug Support’: How we handle of platform-specific bugs.
 - ‘Guaranteed Configurations’: Which runtime configurations for the agent we try to guarantee will work with minimal
@@ -56,30 +45,29 @@ Our [static builds](#static-builds) are expected to work on these platforms if a
 expected
 to work on these platforms with minimal user effort.
 
-| Platform                 | Version        | Official Native Packages               | Notes                                                                                                                                              |
-|--------------------------|----------------|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
-| Alpine Linux             | 3.18           | No                                     | The latest release of Alpine Linux is guaranteed to remain at **Core** tier due to usage for our Docker images                                     |
-| Alma Linux               | 9.x            | x86\_64, AArch64                       | Also includes support for Rocky Linux and other ABI compatible RHEL derivatives                                                                    |
-| Alma Linux               | 8.x            | x86\_64, AArch64                       | Also includes support for Rocky Linux and other ABI compatible RHEL derivatives                                                                    |
-| Amazon Linux             | 2023           | x86\_64, AArch64                       |                                                                                                                                                    |
-| Amazon Linux             | 2              | x86\_64, AArch64                       |                                                                                                                                                    |
-| CentOS                   | 7.x            | x86\_64                                |                                                                                                                                                    |
-| Docker                   | 19.03 or newer | x86\_64, i386, ARMv7, AArch64, POWER8+ | See our [Docker documentation](/packaging/docker/README.md) for more info on using Netdata on Docker |
-| Debian                   | 12.x           | x86\_64, i386, ARMv7, AArch64          |                                                                                                                                                    |
-| Debian                   | 11.x           | x86\_64, i386, ARMv7, AArch64          |                                                                                                                                                    |
-| Fedora                   | 40             | x86\_64, AArch64                       |                                                                                                                                                    |
-| Fedora                   | 39             | x86\_64, AArch64                       |                                                                                                                                                    |
-| openSUSE                 | Leap 15.5      | x86\_64, AArch64                       |                                                                                                                                                    |
-| openSUSE                 | Leap 15.4      | x86\_64, AArch64                       |                                                                                                                                                    |
-| Oracle Linux             | 9.x            | x86\_64, AArch64                       |                                                                                                                                                    |
-| Oracle Linux             | 8.x            | x86\_64, AArch64                       |                                                                                                                                                    |
-| Red Hat Enterprise Linux | 9.x            | x86\_64, AArch64                       |                                                                                                                                                    |
-| Red Hat Enterprise Linux | 8.x            | x86\_64, AArch64                       |                                                                                                                                                    |
-| Red Hat Enterprise Linux | 7.x            | x86\_64                                |                                                                                                                                                    |
-| Ubuntu                   | 24.04          | x86\_64, AArch64, ARMv7                |                                                                                                                                                    |
-| Ubuntu                   | 22.04          | x86\_64, ARMv7, AArch64                |                                                                                                                                                    |
-| Ubuntu                   | 20.04          | x86\_64, ARMv7, AArch64                |                                                                                                                                                    |
-
+| Platform                 | Version        | Official Native Packages               | Notes                                                                                                          |
+|--------------------------|----------------|----------------------------------------|----------------------------------------------------------------------------------------------------------------|
+| Alpine Linux             | 3.18           | No                                     | The latest release of Alpine Linux is guaranteed to remain at **Core** tier due to usage for our Docker images |
+| Alma Linux               | 9.x            | x86\_64, AArch64                       | Also includes support for Rocky Linux and other ABI compatible RHEL derivatives                                |
+| Alma Linux               | 8.x            | x86\_64, AArch64                       | Also includes support for Rocky Linux and other ABI compatible RHEL derivatives                                |
+| Amazon Linux             | 2023           | x86\_64, AArch64                       |                                                                                                                |
+| Amazon Linux             | 2              | x86\_64, AArch64                       |                                                                                                                |
+| CentOS                   | 7.x            | x86\_64                                |                                                                                                                |
+| Docker                   | 19.03 or newer | x86\_64, i386, ARMv7, AArch64, POWER8+ | See our [Docker documentation](/packaging/docker/README.md) for more info on using Netdata on Docker           |
+| Debian                   | 12.x           | x86\_64, i386, ARMv7, AArch64          |                                                                                                                |
+| Debian                   | 11.x           | x86\_64, i386, ARMv7, AArch64          |                                                                                                                |
+| Fedora                   | 40             | x86\_64, AArch64                       |                                                                                                                |
+| Fedora                   | 39             | x86\_64, AArch64                       |                                                                                                                |
+| openSUSE                 | Leap 15.5      | x86\_64, AArch64                       |                                                                                                                |
+| openSUSE                 | Leap 15.4      | x86\_64, AArch64                       |                                                                                                                |
+| Oracle Linux             | 9.x            | x86\_64, AArch64                       |                                                                                                                |
+| Oracle Linux             | 8.x            | x86\_64, AArch64                       |                                                                                                                |
+| Red Hat Enterprise Linux | 9.x            | x86\_64, AArch64                       |                                                                                                                |
+| Red Hat Enterprise Linux | 8.x            | x86\_64, AArch64                       |                                                                                                                |
+| Red Hat Enterprise Linux | 7.x            | x86\_64                                |                                                                                                                |
+| Ubuntu                   | 24.04          | x86\_64, AArch64, ARMv7                |                                                                                                                |
+| Ubuntu                   | 22.04          | x86\_64, ARMv7, AArch64                |                                                                                                                |
+| Ubuntu                   | 20.04          | x86\_64, ARMv7, AArch64                |                                                                                                                |
 
 ### Intermediate
 
@@ -106,16 +94,16 @@ to add support for a new platform, that platform generally will start in this ti
 are expected to work on these platforms if available. Source-based installs are usually expected to work on these
 platforms, but may require some extra effort from users.
 
-| Platform     | Version    | Official Native Packages | Notes                                                                                                     |
-|--------------|------------|--------------------------|-----------------------------------------------------------------------------------------------------------|
-| Clear Linux  | Latest     | No                       |                                                                                                           |
-| Debian       | Sid        | No                       |                                                                                                           |
-| Fedora       | Rawhide    | No                       |                                                                                                           |
-| FreeBSD      | 13-STABLE  | No                       | Netdata is included in the FreeBSD Ports Tree, and this is the recommended installation method on FreeBSD |
-| Gentoo       | Latest     | No                       |                                                                                                           |
-| macOS        | 13         | No                       | Currently only works for Intel-based hardware. Requires Homebrew for dependencies                         |
-| macOS        | 12         | No                       | Currently only works for Intel-based hardware. Requires Homebrew for dependencies                         |
-| macOS        | 11         | No                       | Currently only works for Intel-based hardware. Requires Homebrew for dependencies.                        |
+| Platform    | Version   | Official Native Packages | Notes                                                                                                     |
+|-------------|-----------|--------------------------|-----------------------------------------------------------------------------------------------------------|
+| Clear Linux | Latest    | No                       |                                                                                                           |
+| Debian      | Sid       | No                       |                                                                                                           |
+| Fedora      | Rawhide   | No                       |                                                                                                           |
+| FreeBSD     | 13-STABLE | No                       | Netdata is included in the FreeBSD Ports Tree, and this is the recommended installation method on FreeBSD |
+| Gentoo      | Latest    | No                       |                                                                                                           |
+| macOS       | 13        | No                       | Currently only works for Intel-based hardware. Requires Homebrew for dependencies                         |
+| macOS       | 12        | No                       | Currently only works for Intel-based hardware. Requires Homebrew for dependencies                         |
+| macOS       | 11        | No                       | Currently only works for Intel-based hardware. Requires Homebrew for dependencies.                        |
 
 ## Third-party supported platforms
 

+ 5 - 5
packaging/VERSIONING_AND_PUBLIC_API.md

@@ -36,7 +36,7 @@ will be as up-to-date as possible.
 Versions for nightly builds of the Netdata Agent consist of four parts, a major version, a minor version, a revision
 number, and an optional commit ID, presented like `<major>.<minor>.0-<revision>-<commit>`. For example, a version
 of `1.43.0-11-gb15437502` has a major version of 1, a minor version of 43, a revision of 11, and a commit ID of
-`gb15437502`. A commit ID consists of a lowercaase letter `g`, followed by the short commit hash for the corresponding
+`gb15437502`. A commit ID consists of a lowercase letter `g`, followed by the short commit hash for the corresponding
 commit. If the commit ID is not included, it may be replaced by the word ‘nightly’.
 
 The major and minor version numbers for a nightly build correspond exactly to an associated stable release. A
@@ -80,9 +80,9 @@ notes at least one minor release prior to being merged:
 
 - All mandatory build dependencies which are not vendored in the Netdata Agent code. This includes, but is not
   limited to:
-    - The underlying build system (such as autotools or CMake).
-    - Primary library dependencies (such as libuv).
-    - Any external tooling that is required at build time.
+  - The underlying build system (such as autotools or CMake).
+  - Primary library dependencies (such as libuv).
+  - Any external tooling that is required at build time.
 - The REST API provided by the Netdata Agent’s internal web server, accessible via the `/api` endpoint. This
   does not extend to the charts, labels, or other system-specific data returned by some API endpoints.
 - The protocol used for streaming and replicating data between Netdata Agents.
@@ -138,7 +138,7 @@ Any components which are not explicitly listed above as being part of the public
 API. This includes, but is not limited to:
 
 - Any mandatory build components which are vendored as part of the Netdata sources, such as SQLite3 or libJudy. This
-  extends to both the presence or abscence of such components, as well as the exact version being bundled.
+  extends to both the presence or absence of such components, as well as the exact version being bundled.
 - The exact installation mechanism that will be used on any given system when using our `kickstart.sh` installation
   script.
 - The exact underlying implementation of any data collection plugin.

+ 7 - 7
packaging/building-native-packages-locally.md

@@ -39,16 +39,16 @@ inspect the state of the container and look at build logs.
 
 ### Detailed explanation
 
-The environments used for building our packages are fully self-contianed Docker images built from [Dockerfiles](https://github.com/netdata/helper-images/tree/master/package-builders)
+The environments used for building our packages are fully self-contained Docker images built from [Dockerfiles](https://github.com/netdata/helper-images/tree/master/package-builders)
 These are published on Docker
 Hub with the image name `netdata/package-builders`, and tagged using the name and version of the distribution
 (with the tag corresponding to the suffix on the associated Dockerfile).
 
 The build code expects the following requirements to be met:
 
-- It expects the source tree it should build from to be located at `/netdata`, and expects that said source tree
+* It expects the source tree it should build from to be located at `/netdata`, and expects that said source tree
   is clean (no artifacts left over from previous builds).
-- It expects an environment variable named `VERSION` to be defined, and uses this to control what version number
+* It expects an environment variable named `VERSION` to be defined, and uses this to control what version number
   will be shown in the package metadata and filenames.
 
 Internally, the source tree gets copied to a temporary location for the build process so that the source tree can
@@ -95,7 +95,7 @@ Once you have that set up, the command to build the packages is the same as abov
 `--platform` option to the `docker run` or `podman run` command. The current list of architectures we build for,
 and the correct value for the `--platform` option is:
 
-- 32-bit ARMv7: `linux/arm/v7`
-- 64-bit ARMv8: `linux/arm64/v8`
-- 32-bit x86: `linux/i386`
-- 64-bit x86: `linux/amd64`
+* 32-bit ARMv7: `linux/arm/v7`
+* 64-bit ARMv8: `linux/arm64/v8`
+* 32-bit x86: `linux/i386`
+* 64-bit x86: `linux/amd64`

+ 2 - 13
packaging/docker/README.md

@@ -1,12 +1,3 @@
-<!--
-title: "Install Netdata with Docker"
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/packaging/docker/README.md"
-sidebar_label: "Docker"
-learn_status: "Published"
-learn_rel_path: "Installation/Installation methods"
-sidebar_position: 40
--->
-
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
@@ -34,7 +25,7 @@ along with their descriptions.
 <details open>
 <summary>Privileges</summary>
 
-|       Component       |          Privileges           | Description                                                                                                              | 
+|       Component       |          Privileges           | Description                                                                                                              |
 |:---------------------:|:-----------------------------:|--------------------------------------------------------------------------------------------------------------------------|
 |    cgroups.plugin     |   host PID mode, SYS_ADMIN    | Container network interfaces monitoring. Map virtual interfaces in the system namespace to interfaces inside containers. |
 |      proc.plugin      |       host network mode       | Host system networking stack monitoring.                                                                                 |
@@ -47,7 +38,7 @@ along with their descriptions.
 <details open>
 <summary>Mounts</summary>
 
-|       Component        |           Mounts           | Description                                                                                                                                | 
+|       Component        |           Mounts           | Description                                                                                                                                |
 |:----------------------:|:--------------------------:|--------------------------------------------------------------------------------------------------------------------------------------------|
 |        netdata         |      /etc/os-release       | Host info detection.                                                                                                                       |
 |    diskspace.plugin    |             /              | Host mount points monitoring.                                                                                                              |
@@ -177,14 +168,12 @@ Add `- /run/dbus:/run/dbus:ro` to the netdata service `volumes`.
 
 ### With NVIDIA GPUs monitoring
 
-
 Monitoring NVIDIA GPUs requires:
 
 - Using official [NVIDIA driver](https://www.nvidia.com/Download/index.aspx).
 - Installing [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html).
 - Allowing the Netdata container to access GPU resources.
 
-
 <Tabs>
 <TabItem value="docker_run" label="docker run">
 

+ 9 - 9
packaging/installer/UNINSTALL.md

@@ -1,7 +1,7 @@
 # Uninstall Netdata
 
-> ### Note 
-> 
+> **Note**
+>
 > If you're having trouble updating Netdata, moving from one installation method to another, or generally having
 > issues with your Netdata Agent installation, consider our [reinstalling Netdata](/packaging/installer/REINSTALL.md) instead of removing the Netdata Agent entirely.
 
@@ -40,15 +40,15 @@ installation prefix it will usually be located in a similar place under that pre
 
 A workflow for uninstallation looks like this:
 
-1.  Find your `.environment` file, which is usually `/etc/netdata/.environment` in a default installation.
-2.  If you cannot find that file and would like to uninstall Netdata, then create a new file with the following content:
+1. Find your `.environment` file, which is usually `/etc/netdata/.environment` in a default installation.
+2. If you cannot find that file and would like to uninstall Netdata, then create a new file with the following content:
 
-```sh
-NETDATA_PREFIX="<installation prefix>"   # put what you used as a parameter to shell installed `--install-prefix` flag. Otherwise it should be empty
-NETDATA_ADDED_TO_GROUPS="<additional groups>"  # Additional groups for a user running the Netdata process
-```
+    ```sh
+    NETDATA_PREFIX="<installation prefix>"   # put what you used as a parameter to shell installed `--install-prefix` flag. Otherwise it should be empty
+    NETDATA_ADDED_TO_GROUPS="<additional groups>"  # Additional groups for a user running the Netdata process
+    ```
 
-3.  Run `netdata-uninstaller.sh` as follows
+3. Run `netdata-uninstaller.sh` as follows
 
     3.1 **Interactive mode (Default)**
 

+ 6 - 7
packaging/installer/UPDATE.md

@@ -13,15 +13,15 @@ icon in the local Agent dashboard's top navigation. This modal informs you wheth
 
 The exact update method to use depends on the install type:
 
--   Installs with an install type of 'custom' usually indicate installing a third-party package through the system
+- Installs with an install type of 'custom' usually indicate installing a third-party package through the system
     package manager. To update these installs, you should update the package just like you would any other package
     on your system.
--   Installs with an install type starting with `binpkg` or ending with `build` or `static` can be updated using
+- Installs with an install type starting with `binpkg` or ending with `build` or `static` can be updated using
     our [regular update method](#updates-for-most-systems).
--   Installs with an install type of 'oci' were created from our official Docker images, and should be updated
+- Installs with an install type of 'oci' were created from our official Docker images, and should be updated
     using our [Docker](#docker) update procedure.
--   macOS users should check [our update instructions for macOS](#macos).
--   Manually built installs should check [our update instructions for manual builds](#manual-installation-from-git).
+- macOS users should check [our update instructions for macOS](#macos).
+- Manually built installs should check [our update instructions for manual builds](#manual-installation-from-git).
 
 ## Determine which installation method you used
 
@@ -46,7 +46,6 @@ The following table contains all possible installation types:
 | custom             | Anything not covered by the other identifiers, including manual builds, manually running netdata-installer.sh, and third-party packages (community).        |
 | Unknown            | Same as custom.                                                                                                                                             |
 
-
 If you are using an older version of Netdata, or the above command produces no output, you can run our one-line
 installation script in dry-run mode to attempt to determine what method to use to update by running the following
 command:
@@ -189,7 +188,7 @@ and:
 /opt/netdata/usr/libexec/netdata/netdata-updater.sh --disable-auto-updates
 ```
 
-## Control runtime behavior of the updater script.
+## Control runtime behavior of the updater script
 
 Starting with v1.40.0, the `netdata-updater.sh` script supports a config file called `netdata-updater.conf`,
 located in the same directory as the main `netdata.conf` file. This file uses POSIX shell script syntax to define

+ 7 - 17
packaging/installer/methods/ansible.md

@@ -1,13 +1,3 @@
-<!--
-title: "Deploy Netdata with Ansible"
-description: "Deploy an infrastructure monitoring solution in minutes with the Netdata Agent and Ansible. Use and customize a simple playbook for monitoring as code."
-image: /img/seo/guides/deploy/ansible.png
-custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/ansible.md
-sidebar_label: "Ansible"
-learn_status: "Published"
-learn_rel_path: "Installation/Install on specific environments"
--->
-
 # Deploy Netdata with Ansible
 
 Netdata's [one-line kickstart](/packaging/installer/README.md) is zero-configuration, highly adaptable, and compatible with tons
@@ -22,7 +12,7 @@ code?
 Enter [Ansible](https://ansible.com), a popular system provisioning, configuration management, and infrastructure as
 code (IaC) tool. Ansible uses **playbooks** to glue many standardized operations together with a simple syntax, then run
 those operations over standard and secure SSH connections. There's no agent to install on the remote system, so all you
-have to worry about is your application and your monitoring software. 
+have to worry about is your application and your monitoring software.
 
 Ansible has some competition from the likes of [Puppet](https://puppet.com/) or [Chef](https://www.chef.io/), but the
 most valuable feature about Ansible is **idempotent**. From the [Ansible
@@ -42,9 +32,9 @@ minutes.
 
 ## Prerequisites
 
--   A Netdata Cloud account. [Sign in and create one](https://app.netdata.cloud) if you don't have one already.
--   An administration system with [Ansible](https://www.ansible.com/) installed.
--   One or more nodes that your administration system can access via [SSH public
+- A Netdata Cloud account. [Sign in and create one](https://app.netdata.cloud) if you don't have one already.
+- An administration system with [Ansible](https://www.ansible.com/) installed.
+- One or more nodes that your administration system can access via [SSH public
     keys](https://git-scm.com/book/en/v2/Git-on-the-Server-Generating-Your-SSH-Public-Key) (preferably password-less).
 
 ## Download and configure the playbook
@@ -71,7 +61,7 @@ cd ansible-quickstart
 
 The `hosts` file contains a list of IP addresses or hostnames that Ansible will try to run the playbook against. The
 `hosts` file that comes with the repository contains two example IP addresses, which you should replace according to the
-IP address/hostname of your nodes. 
+IP address/hostname of your nodes.
 
 ```conf
 203.0.113.0  hostname=node-01
@@ -110,7 +100,7 @@ and `claim_room` variables.
 
 To find your `claim_token` and `claim_room`, go to Netdata Cloud, then click on your Space's name in the top navigation,
 then click on **Manage your Space**. Click on the **Nodes** tab in the panel that appears, which displays a script with
-`token` and `room` strings. 
+`token` and `room` strings.
 
 ![Animated GIF of finding the claiming script and the token and room
 strings](https://user-images.githubusercontent.com/1153921/98740235-f4c3ac00-2367-11eb-8ffd-e9ab0f04c463.gif)
@@ -123,7 +113,7 @@ claim_rooms: XXXXX
 ```
 
 Change the `dbengine_multihost_disk_space` if you want to change the metrics retention policy by allocating more or less
-disk space for storing metrics. The default is 2048 Mib, or 2 GiB. 
+disk space for storing metrics. The default is 2048 Mib, or 2 GiB.
 
 Because we're connecting this node to Netdata Cloud, and will view its dashboards there instead of via the IP address or
 hostname of the node, the playbook disables that local dashboard by setting `web_mode` to `none`. This gives a small

+ 5 - 14
packaging/installer/methods/aws.md

@@ -1,12 +1,3 @@
-<!--
-title: "Install Netdata on AWS"
-description: "The Netdata Agent runs on all popular cloud providers, but often requires additional steps and configuration for full functionality."
-custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/aws.md
-sidebar_label: "AWS"
-learn_status: "Published"
-learn_rel_path: "Installation/Install on specific environments"
--->
-
 # Install Netdata on AWS
 
 Netdata is fully compatible with Amazon Web Services (AWS).
@@ -41,11 +32,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/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-apache.md)
--   [Nginx](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-nginx.md)
--   [Caddy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-caddy.md)
--   [HAProxy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-haproxy.md)
--   [lighttpd](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-lighttpd.md)
+- [Apache](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-apache.md)
+- [Nginx](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-nginx.md)
+- [Caddy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-caddy.md)
+- [HAProxy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-haproxy.md)
+- [lighttpd](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-lighttpd.md)
 
 Sign in to the [AWS console](https://console.aws.amazon.com/) and navigate to the EC2 dashboard. Click on the **Security
 Groups** link in the navigation, beneath the **Network & Security** heading. Find the Security Group your instance

+ 6 - 17
packaging/installer/methods/azure.md

@@ -1,15 +1,6 @@
-<!--
-title: "Install Netdata on Azure"
-description: "The Netdata Agent runs on all popular cloud providers, but often requires additional steps and configuration for full functionality."
-custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/azure.md
-sidebar_label: "Azure"
-learn_status: "Published"
-learn_rel_path: "Installation/Install on specific environments"
--->
-
 # Install Netdata on Azure
 
-Netdata is fully compatible with Azure. 
+Netdata is fully compatible with Azure.
 You can install Netdata on cloud instances to monitor the apps/services running there, or use
 multiple instances in a [parent-child streaming](/src/streaming/README.md) configuration.
 
@@ -41,11 +32,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/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-apache.md)
--   [Nginx](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-nginx.md)
--   [Caddy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-caddy.md)
--   [HAProxy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-haproxy.md)
--   [lighttpd](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-lighttpd.md)
+- [Apache](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-apache.md)
+- [Nginx](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-nginx.md)
+- [Caddy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-caddy.md)
+- [HAProxy](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-haproxy.md)
+- [lighttpd](/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-lighttpd.md)
 
 Sign in to the [Azure portal](https://portal.azure.com) and open the virtual machine running Netdata. Click on the
 **Networking** link beneath the **Settings** header, then click on the **Add inbound security rule** button.
@@ -64,5 +55,3 @@ Name: Netdata
 ```
 
 Click **Add** to apply your new inbound security rule.
-
-

+ 12 - 19
packaging/installer/methods/freebsd.md

@@ -1,12 +1,3 @@
-<!--
-title: "Install Netdata on FreeBSD"
-description: "Install Netdata on FreeBSD to monitor the health and performance of bare metal or VMs with thousands of real-time, per-second metrics."
-custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freebsd.md
-sidebar_label: "FreeBSD"
-learn_status: "Published"
-learn_rel_path: "Installation/Install on specific environments"
--->
-
 # Install Netdata on FreeBSD
 
 > 💡 This document is maintained by Netdata's community, and may not be completely up-to-date. Please double-check the
@@ -24,7 +15,7 @@ This step needs root privileges.
 pkg install bash e2fsprogs-libuuid git curl autoconf automake pkgconf pidof liblz4 libuv json-c cmake gmake
 ```
 
-Please respond in the affirmative for any relevant prompts during the installation process. 
+Please respond in the affirmative for any relevant prompts during the installation process.
 
 ## Install Netdata
 
@@ -35,9 +26,10 @@ If you have a Netdata cloud account then clicking on the **Connect Nodes** butto
 ```sh
 wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token <CLAIM_TOKEN> --claim-url https://app.netdata.cloud
 ```
-Please respond in the affirmative for any relevant prompts during the installation process. 
 
-Once the installation is completed, you should be able to start monitoring the FreeBSD server using Netdata. 
+Please respond in the affirmative for any relevant prompts during the installation process.
+
+Once the installation is completed, you should be able to start monitoring the FreeBSD server using Netdata.
 
 Netdata can also be installed via [FreeBSD ports](https://www.freshports.org/net-mgmt/netdata).
 
@@ -89,7 +81,8 @@ more about the information collected and how to opt-out, check the [anonymous st
 page](/docs/netdata-agent/configuration/anonymous-telemetry-events.md).
 
 ## Updating the Agent on FreeBSD
-If you have not passed the `--auto-update` or `-u` parameter for the installer to enable automatic updating, repeat the last step to update Netdata whenever a new version becomes available. 
+
+If you have not passed the `--auto-update` or `-u` parameter for the installer to enable automatic updating, repeat the last step to update Netdata whenever a new version becomes available.
 The `netdata-updater.sh` script will update your Agent.
 
 ## Optional parameters to alter your installation
@@ -102,9 +95,9 @@ The `kickstart.sh` script accepts a number of optional parameters to control how
 - `--dry-run`: Show what the installer would do, but don’t actually do any of it.
 - `--dont-start-it`: Don’t auto-start the daemon after installing. This parameter is not guaranteed to work.
 - `--release-channel`: Specify a particular release channel to install from. Currently supported release channels are:
-    - `nightly`: Installs a nightly build (this is currently the default).
-    - `stable`: Installs a stable release.
-    - `default`: Explicitly request whatever the current default is.
+  - `nightly`: Installs a nightly build (this is currently the default).
+  - `stable`: Installs a stable release.
+  - `default`: Explicitly request whatever the current default is.
 - `--nightly-channel`: Synonym for `--release-channel nightly`.
 - `--stable-channel`: Synonym for `--release-channel stable`.
 - `--auto-update`: Enable automatic updates (this is the default).
@@ -119,15 +112,15 @@ The `kickstart.sh` script accepts a number of optional parameters to control how
 - `--local-build-options`: Specify additional options to pass to the installer code when building locally. Only valid if `--build-only` is also specified.
 - `--static-install-options`: Specify additional options to pass to the static installer code. Only valid if --static-only is also specified.
 
-The following options are mutually exclusive and specifiy special operations other than trying to install Netdata normally or update an existing install:
+The following options are mutually exclusive and specify special operations other than trying to install Netdata normally or update an existing install:
 
 - `--reinstall`: If there is an existing install, reinstall it instead of trying to update it. If there is not an existing install, install netdata normally.
-- `--reinstall-even-if-unsafe`: If there is an existing install, reinstall it instead of trying to update it, even if doing so is known to potentially break things (for example, if we cannot detect what tyep of installation it is). If there is not an existing install, install Netdata normally.
+- `--reinstall-even-if-unsafe`: If there is an existing install, reinstall it instead of trying to update it, even if doing so is known to potentially break things (for example, if we cannot detect what type of installation it is). If there is not an existing install, install Netdata normally.
 - `--reinstall-clean`: If there is an existing install, uninstall it before trying to install Netdata. Fails if there is no existing install.
 - `--uninstall`: Uninstall an existing installation of Netdata. Fails if there is no existing install.
 - `--claim-only`: If there is an existing install, only try to claim it without attempting to update it. If there is no existing install, install and claim Netdata normally.
 - `--repositories-only`: Only install repository configuration packages instead of doing a full install of Netdata. Automatically sets --native-only.
-- `--prepare-offline-install-source`: Instead of insallling the agent, prepare a directory that can be used to install on another system without needing to download anything. See our [offline installation documentation](/packaging/installer/methods/offline.md) for more info.
+- `--prepare-offline-install-source`: Instead of installing the agent, prepare a directory that can be used to install on another system without needing to download anything. See our [offline installation documentation](/packaging/installer/methods/offline.md) for more info.
 
 Additionally, the following environment variables may be used to further customize how the script runs (most users
 should not need to use special values for any of these):

Some files were not shown because too many files changed in this diff