@cryptotaxi247 / netdata-1 / commits / a458db4ae

Install fix admonition docs (#20136)

kanelatechnical committed Apr 17, 2025 at 13:43 UTC a458db4ae5a91cac55376b359916751ff985039d
6 files changed +60 -32
packaging/installer/methods/ansible.md
+3 -5
@@ -4,13 +4,11 @@ Meet [Ansible](https://ansible.com), a popular tool for provisioning, configurat
4
5 This guide walks you through deploying the **Netdata Agent** across multiple nodes using an [Ansible playbook](https://github.com/netdata/community/tree/main/configuration-management/ansible-quickstart/), managing configurations, and connecting to **Netdata Cloud**—all in minutes.
6
7 -What does **idempotent** mean? From the [Ansible glossary](https://docs.ansible.com/ansible/latest/reference_appendices/glossary.html):
7 +:::note
8
9 -> With Ansible, you can deploy Netdata repeatedly without disrupting your infrastructure—ensuring monitoring as code.
9 +With Ansible, you can deploy Netdata repeatedly without disrupting your infrastructure—ensuring monitoring as code.
10
11 -This guide walks you through deploying the **Netdata Agent** across multiple nodes using an [Ansible playbook](https://github.com/netdata/community/tree/main/configuration-management/ansible-quickstart/), managing configurations, and connecting to **Netdata Cloud**—all in minutes.
12 -
13 -> With Ansible, you can deploy Netdata repeatedly without disrupting your infrastructure—ensuring monitoring as code.
11 +:::
12
13 ---
14
packaging/installer/methods/freebsd.md
+1 -1
@@ -134,4 +134,4 @@ cd /opt/netdata/usr/libexec/netdata/
134
135 ## Telemetry Notice
136
137 -Anonymous usage data is collected by default. You can learn more or opt-out [here](/docs/netdata-agent/configuration/anonymous-telemetry-events.md)
\ No newline at end of file
137 +Anonymous usage data is collected by default. You can learn more or opt-out [here](/docs/netdata-agent/configuration/anonymous-telemetry-events.md).
\ No newline at end of file
packaging/installer/methods/offline.md
+32 -15
@@ -10,8 +10,11 @@ This method:
10 - Works with static builds only (for now).
11 - Does *not* support automatic updates on offline systems.
12
13 -> [!NOTE]
14 -> Local package tools like `apt-offline` may work for DEB/RPM installs — but we don’t officially support them.
13 +:::note
14 +
15 +Local package tools like `apt-offline` may work for DEB/RPM installs — but we don’t officially support them.
16 +
17 +:::
18
19 ---
20
@@ -38,10 +41,12 @@ Run the following command:
41 sh /tmp/netdata-kickstart.sh --release-channel stable --prepare-offline-install-source ./netdata-offline
42 ```
43
41 - > [!NOTE]
42 - > The folder name `netdata-offline` is just an example — use any name you want.
43 - >
44 - > To use the nightly channel instead, replace `stable` with `nightly`.
44 +:::note
45 +
46 +The folder name `netdata-offline` is just an example — use any name you want.
47 +To use the nightly channel instead, replace `stable` with `nightly`.
48 +
49 +:::
50
51 **What's Included**:
52
@@ -62,12 +67,18 @@ The script creates a directory with all necessary files:
67
68 Copy the entire `netdata-offline` directory to your offline system using your preferred method (USB drive, secure copy, etc.).
69
65 -> [!IMPORTANT]
66 -> Do not rename or modify any files in the package.
67 -> The installation script expects the exact directory structure and filenames.
70 +:::warning
71 +
72 +Do not rename or modify any files in the package.
73 +The installation script expects the exact directory structure and filenames.
74 +
75 +:::
76
69 -> [!TIP]
70 -> The folder name `netdata-offline` is just an example — use any name you want.
77 +:::tip
78 +
79 +The folder name `netdata-offline` is just an example — use any name you want.
80 +
81 +:::
82
83 ---
84
@@ -109,8 +120,11 @@ sh /tmp/netdata-kickstart.sh --release-channel stable --prepare-offline-install-
120
121 1. Copy the entire `netdata-offline` directory to your offline system.
122
112 -> ⚠️ Warning
113 -> Don't rename or modify the files.
123 +:::warning
124 +
125 +Don't rename or modify the files.
126 +
127 +:::
128
129 ---
130
@@ -125,5 +139,8 @@ The `install.sh` script accepts the [same parameters](/packaging/installer/metho
139
140 ## Automatic Updates
141
128 -> [!NOTE]
129 -> Automatic updates are *disabled* by default for offline installations — since there’s no network connection.
\ No newline at end of file
142 +:::note
143 +
144 +Automatic updates are *disabled* by default for offline installations — since there’s no network connection.
145 +
146 +:::
\ No newline at end of file
packaging/installer/methods/packages.md
+11 -4
@@ -6,8 +6,11 @@ Our [kickstart.sh installer](/packaging/installer/methods/kickstart.md) uses the
6
7 Add `--native-only` when running `kickstart.sh` to force native packages. The script will fail if native packages aren’t available.
8
9 -> [!NOTE]
10 -> Until late 2024, Netdata packages were hosted on Package Cloud. All packages are now provided exclusively from our own repositories.
9 +:::note
10 +
11 +Until late 2024, Netdata packages were hosted on Package Cloud. All packages are now provided exclusively from our own repositories.
12 +
13 +:::
14
15 ---
16
@@ -146,10 +149,14 @@ Mirror root URL:
149
150 ## Public Mirrors of the Official Netdata Repositories
151
149 -> **There are no official public mirrors**.
152 +:::note
153 +
154 +**There are no official public mirrors**.
155 +
156 +:::
157
158 If you wish to provide a public mirror of Netdata repositories:
159
160 - You’re free to do so.
161 - Please clearly state to your users that it is *not* an official mirror.
155 -- Follow best practices for repository mirroring and security.
162 +- Follow best practices for repository mirroring and security.
\ No newline at end of file
packaging/makeself/README.md
+1 -1
@@ -132,4 +132,4 @@ If Netdata crashes during development or testing:
132 3. Include:
133 - Build details (architecture, version)
134 - Complete stack trace
135 - - Steps to reproduce the issue
135 + - Steps to reproduce the issue
\ No newline at end of file
packaging/windows/WINDOWS_INSTALLER.md
+12 -6
@@ -2,9 +2,12 @@
2
3 Netdata provides a simple Windows installer for quick setup.
4
5 -> [!NOTE]
6 -> The Windows Agent is available for users with paid Netdata subscriptions.
7 -> Free users will have limited functionality.
5 +:::note
6 +
7 +The Windows Agent is available for users with paid Netdata subscriptions.
8 +Free users will have limited functionality.
9 +
10 +:::
11
12 ---
13
@@ -32,8 +35,11 @@ Choose the version that suits your needs:
35
36 Use silent mode to deploy Netdata without user interaction (ideal for automation).
37
35 -> [!TIP]
36 -> Run the command prompt as Administrator.
38 +:::tip
39 +
40 +Run the command prompt as Administrator.
41 +
42 +:::
43
44 ---
45
@@ -97,4 +103,4 @@ http://localhost:19999
103 By using silent installation, you agree to:
104
105 - [GPL-3 License](https://raw.githubusercontent.com/netdata/netdata/refs/heads/master/LICENSE) — Netdata Agent
100 -- [NCUL1 License](https://app.netdata.cloud/LICENSE.txt) — Netdata Web Interface
106 +- [NCUL1 License](https://app.netdata.cloud/LICENSE.txt) — Netdata Web Interface
\ No newline at end of file