summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChris Akritidis <43294513+cakrit@users.noreply.github.com>2023-02-03 08:11:56 -0800
committerGitHub <noreply@github.com>2023-02-03 08:11:56 -0800
commitaef3f517a58ce703e9a3cee43b0b701e476731cc (patch)
treead685a4dad8bda04b636a989be41d3036bb73e20
parent75d25a95d6450f2e9ca1ee6b0a0a6eb6c1ad75cd (diff)
Libnetdata readmes learn (#14416)
* Add remaining libnetdata readmes to learn * Move all libnetdata readmes in learn under Developer/libnetdata libraries except for the main README * Add the moved array allocator
-rw-r--r--libnetdata/README.md4
-rw-r--r--libnetdata/adaptive_resortable_list/README.md2
-rw-r--r--libnetdata/aral/README.md4
-rw-r--r--libnetdata/avl/README.md4
-rw-r--r--libnetdata/buffer/README.md2
-rw-r--r--libnetdata/circular_buffer/README.md6
-rw-r--r--libnetdata/config/README.md2
-rw-r--r--libnetdata/dictionary/README.md2
-rw-r--r--libnetdata/ebpf/README.md8
-rw-r--r--libnetdata/json/README.md4
-rw-r--r--libnetdata/july/README.md2
-rw-r--r--libnetdata/locks/README.md5
-rw-r--r--libnetdata/log/README.md10
-rw-r--r--libnetdata/onewayalloc/README.md4
-rw-r--r--libnetdata/popen/README.md10
-rw-r--r--libnetdata/procfile/README.md4
-rw-r--r--libnetdata/simple_pattern/README.md2
-rw-r--r--libnetdata/statistical/README.md7
-rw-r--r--libnetdata/storage_number/README.md4
-rw-r--r--libnetdata/string/README.md7
-rw-r--r--libnetdata/threads/README.md7
-rw-r--r--libnetdata/url/README.md9
22 files changed, 99 insertions, 10 deletions
diff --git a/libnetdata/README.md b/libnetdata/README.md
index fe0690d687..1424faf6ca 100644
--- a/libnetdata/README.md
+++ b/libnetdata/README.md
@@ -1,6 +1,10 @@
<!--
title: "libnetdata"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/README.md
+sidebar_label: "libnetdata"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/libnetdata"
-->
# libnetdata
diff --git a/libnetdata/adaptive_resortable_list/README.md b/libnetdata/adaptive_resortable_list/README.md
index c47b28553d..957578487c 100644
--- a/libnetdata/adaptive_resortable_list/README.md
+++ b/libnetdata/adaptive_resortable_list/README.md
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/adapt
sidebar_label: "Adaptive Re-sortable List (ARL)"
learn_status: "Published"
learn_topic_type: "Tasks"
-learn_rel_path: "Developers"
+learn_rel_path: "Developers/libnetdata libraries"
-->
# Adaptive Re-sortable List (ARL)
diff --git a/libnetdata/aral/README.md b/libnetdata/aral/README.md
index 2b7376636e..3b0f5bbd62 100644
--- a/libnetdata/aral/README.md
+++ b/libnetdata/aral/README.md
@@ -1,6 +1,10 @@
<!--
title: "Array Allocator"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/aral/README.md
+sidebar_label: "Array allocator"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/libnetdata libraries"
-->
# Array Allocator
diff --git a/libnetdata/avl/README.md b/libnetdata/avl/README.md
index 36392bd79f..2b03fec4af 100644
--- a/libnetdata/avl/README.md
+++ b/libnetdata/avl/README.md
@@ -1,6 +1,10 @@
<!--
title: "AVL"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/avl/README.md
+sidebar_label: "AVL"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/libnetdata libraries"
-->
# AVL
diff --git a/libnetdata/buffer/README.md b/libnetdata/buffer/README.md
index 1d18c2c213..6a84fd8a31 100644
--- a/libnetdata/buffer/README.md
+++ b/libnetdata/buffer/README.md
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/buffe
sidebar_label: "BUFFER library"
learn_status: "Published"
learn_topic_type: "Tasks"
-learn_rel_path: "Developers"
+learn_rel_path: "Developers/libnetdata libraries"
-->
# BUFFER
diff --git a/libnetdata/circular_buffer/README.md b/libnetdata/circular_buffer/README.md
index 4482173d7f..23980dff39 100644
--- a/libnetdata/circular_buffer/README.md
+++ b/libnetdata/circular_buffer/README.md
@@ -1,6 +1,10 @@
<!--
-title: "circular_buffer"
+title: "Circular Buffer"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/circular_buffer/README.md
+sidebar_label: "Circular Buffer"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/libnetdata libraries"
-->
# Circular Buffer
diff --git a/libnetdata/config/README.md b/libnetdata/config/README.md
index 8069fdc9b4..c34cf9255a 100644
--- a/libnetdata/config/README.md
+++ b/libnetdata/config/README.md
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/confi
sidebar_label: "Netdata ini config files"
learn_status: "Published"
learn_topic_type: "Tasks"
-learn_rel_path: "Developers"
+learn_rel_path: "Developers/libnetdata libraries"
-->
# Netdata ini config files
diff --git a/libnetdata/dictionary/README.md b/libnetdata/dictionary/README.md
index cd38a6ca8d..508c4e0311 100644
--- a/libnetdata/dictionary/README.md
+++ b/libnetdata/dictionary/README.md
@@ -3,7 +3,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/dicti
sidebar_label: "Dictionaries"
learn_status: "Published"
learn_topic_type: "Tasks"
-learn_rel_path: "Developers"
+learn_rel_path: "Developers/libnetdata libraries"
-->
# Dictionaries
diff --git a/libnetdata/ebpf/README.md b/libnetdata/ebpf/README.md
index 534867f317..c2dabe1027 100644
--- a/libnetdata/ebpf/README.md
+++ b/libnetdata/ebpf/README.md
@@ -1,5 +1,13 @@
<!--
+title "eBPF"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/ebpf/README.md
+sidebar_label: "eBPF"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/libnetdata libraries"
-->
+# eBPF library
+
+Netdata's eBPF library supports the [eBPF collector](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md).
diff --git a/libnetdata/json/README.md b/libnetdata/json/README.md
index 2e04b8b6bc..e772f114de 100644
--- a/libnetdata/json/README.md
+++ b/libnetdata/json/README.md
@@ -1,6 +1,10 @@
<!--
title: "json"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/json/README.md
+sidebar_label: "json"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/libnetdata libraries"
-->
# json
diff --git a/libnetdata/july/README.md b/libnetdata/july/README.md
index 8f6e4d9be1..df2a3d38c2 100644
--- a/libnetdata/july/README.md
+++ b/libnetdata/july/README.md
@@ -3,7 +3,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/july/
sidebar_label: "July interface"
learn_status: "Published"
learn_topic_type: "Tasks"
-learn_rel_path: "Developers"
+learn_rel_path: "Developers/libnetdata libraries"
-->
diff --git a/libnetdata/locks/README.md b/libnetdata/locks/README.md
index 9132edc430..8810e3d175 100644
--- a/libnetdata/locks/README.md
+++ b/libnetdata/locks/README.md
@@ -1,5 +1,10 @@
<!--
+title: "Locks"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/locks/README.md
+sidebar_label: "Locks"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/libnetdata libraries"
-->
## How to trace netdata locks
diff --git a/libnetdata/log/README.md b/libnetdata/log/README.md
index a767dd4465..5f9e5bc7b0 100644
--- a/libnetdata/log/README.md
+++ b/libnetdata/log/README.md
@@ -1,5 +1,15 @@
<!--
+title "Log"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/log/README.md
+sidebar_label: "Log"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/libnetdata libraries"
-->
+# Log
+
+The netdata log library supports debug, info, error and fatal error logging.
+By default we have an access log, an error log and a collectors log.
+
diff --git a/libnetdata/onewayalloc/README.md b/libnetdata/onewayalloc/README.md
index 8374d19bab..3fa0d9fd31 100644
--- a/libnetdata/onewayalloc/README.md
+++ b/libnetdata/onewayalloc/README.md
@@ -1,10 +1,10 @@
<!--
title: "One Way Allocator"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/onewayallocator/README.md
-sidebar_label: "One Way Allocator"
+sidebar_label: "One way allocator"
learn_status: "Published"
learn_topic_type: "Tasks"
-learn_rel_path: "Developers"
+learn_rel_path: "Developers/libnetdata libraries"
-->
# One Way Allocator
diff --git a/libnetdata/popen/README.md b/libnetdata/popen/README.md
index db4aefaedd..804690d13f 100644
--- a/libnetdata/popen/README.md
+++ b/libnetdata/popen/README.md
@@ -1,5 +1,15 @@
<!--
+title: "popen"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/popen/README.md
+sidebar_label: "popen"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/libnetdata libraries"
-->
+# popen
+
+Process management library
+
+
diff --git a/libnetdata/procfile/README.md b/libnetdata/procfile/README.md
index 97861a9113..8610e77e52 100644
--- a/libnetdata/procfile/README.md
+++ b/libnetdata/procfile/README.md
@@ -1,6 +1,10 @@
<!--
title: "PROCFILE"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/procfile/README.md
+sidebar_label: "Procfile"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/libnetdata libraries"
-->
# PROCFILE
diff --git a/libnetdata/simple_pattern/README.md b/libnetdata/simple_pattern/README.md
index dc119f2636..a0a7cf6888 100644
--- a/libnetdata/simple_pattern/README.md
+++ b/libnetdata/simple_pattern/README.md
@@ -5,7 +5,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/simpl
sidebar_label: "Simple patterns"
learn_status: "Published"
learn_topic_type: "Tasks"
-learn_rel_path: "Developers"
+learn_rel_path: "Developers/libnetdata libraries"
-->
# Simple patterns
diff --git a/libnetdata/statistical/README.md b/libnetdata/statistical/README.md
index f254081d28..8fa101f0e3 100644
--- a/libnetdata/statistical/README.md
+++ b/libnetdata/statistical/README.md
@@ -1,5 +1,12 @@
<!--
+title: "Statistical functions"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/statistical/README.md
+sidebar_label: "Statistical functions"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/libnetdata libraries"
-->
+# Statistical functions
+A library for easy and fast calculations of statistical measurements like average, median etc.
diff --git a/libnetdata/storage_number/README.md b/libnetdata/storage_number/README.md
index 4cd19a98bc..da2c3ccfd0 100644
--- a/libnetdata/storage_number/README.md
+++ b/libnetdata/storage_number/README.md
@@ -1,6 +1,10 @@
<!--
title: "Netdata storage number"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/storage_number/README.md
+sidebar_label: "Storage number"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/libnetdata libraries"
-->
# Netdata storage number
diff --git a/libnetdata/string/README.md b/libnetdata/string/README.md
index e73ab2696c..b1c6e61c37 100644
--- a/libnetdata/string/README.md
+++ b/libnetdata/string/README.md
@@ -1,5 +1,10 @@
<!--
+title: "String"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/string/README.md
+sidebar_label: "String"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/libnetdata libraries"
-->
# STRING
@@ -17,4 +22,4 @@ index lookup to find it.
Once there is a `STRING *`, the actual `const char *` can be accessed with `string2str()`.
-All STRING should be constant. Changing the contents of a `const char *` that has been acquired by `string2str()` should never happen. \ No newline at end of file
+All STRING should be constant. Changing the contents of a `const char *` that has been acquired by `string2str()` should never happen.
diff --git a/libnetdata/threads/README.md b/libnetdata/threads/README.md
index 75ab11b1ea..71979feac4 100644
--- a/libnetdata/threads/README.md
+++ b/libnetdata/threads/README.md
@@ -1,5 +1,12 @@
<!--
+title: Threads
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/threads/README.md
+sidebar_label: "Threads"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/libnetdata libraries"
-->
+# Threads
+Netdata uses a custom threads library
diff --git a/libnetdata/url/README.md b/libnetdata/url/README.md
index bd289d955b..cca6f8731e 100644
--- a/libnetdata/url/README.md
+++ b/libnetdata/url/README.md
@@ -1,5 +1,14 @@
<!--
+title: "URL"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/url/README.md
+sidebar_label: "URL"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/libnetdata libraries"
-->
+# URL
+
+The URL library contains common functions useful for URLs, like conversion from/to hex,
+URL encode/decode and query string parsing.