From 1c62c6e60ba9f189568bafa90a1989d55a85ed15 Mon Sep 17 00:00:00 2001
From: k32 <10274441+k32@users.noreply.github.com>
Date: Fri, 18 Feb 2022 16:26:18 +0100
Subject: [PATCH 1/2] docs: Add documentation for the sysmon roots

---
 .github/workflows/spelling.yml |  3 ++-
 apps/emqx/src/emqx_schema.erl  | 14 +++++++++++---
 2 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml
index a5dd8a981..f6da5ad65 100644
--- a/.github/workflows/spelling.yml
+++ b/.github/workflows/spelling.yml
@@ -17,7 +17,8 @@ jobs:
     - uses: actions/checkout@v2
     - uses: actions/download-artifact@v2
       with:
-        name: emqx-24.1.5-4-ubuntu20.04
+        name:  emqx-24.1.5-4-ubuntu20.04
+        workflow: build_slim_packages.yaml
         path: .
     - name: Run spellcheck
       run: |
diff --git a/apps/emqx/src/emqx_schema.erl b/apps/emqx/src/emqx_schema.erl
index 8c900803f..7289dcef4 100644
--- a/apps/emqx/src/emqx_schema.erl
+++ b/apps/emqx/src/emqx_schema.erl
@@ -922,15 +922,23 @@ fields("broker_perf") ->
 fields("sysmon") ->
     [ {"vm",
        sc(ref("sysmon_vm"),
-          #{})
+          #{ desc => "This part of the configuration is responsible for collecting
+ BEAM VM events, such as long garbage collection, traffic congesiton in the inter-broker
+ communication, etc."
+           })
       }
     , {"os",
        sc(ref("sysmon_os"),
-          #{})
+          #{ desc => "This part of the configuration is responsible for monitoring
+ the host OS health, such as free memory, disk space, CPU load, etc."
+           })
       }
     , {"top",
        sc(ref("sysmon_top"),
-          #{})
+          #{ desc => "This part of the configuration is responsible for monitoring
+ the Erlang processes in the VM. This information can be sent to an external
+ PostgreSQL database. This feature is inactive unless the PostgreSQL sink is configured."
+           })
       }
     ];
 

From 9fb35a1d644393107806a62d82c01bffe5556506 Mon Sep 17 00:00:00 2001
From: k32 <10274441+k32@users.noreply.github.com>
Date: Fri, 18 Feb 2022 18:35:16 +0100
Subject: [PATCH 2/2] docs: Fix typo

Co-authored-by: Thales Macedo Garitezi <thalesmg@gmail.com>
---
 apps/emqx/src/emqx_schema.erl | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/apps/emqx/src/emqx_schema.erl b/apps/emqx/src/emqx_schema.erl
index 7289dcef4..51a9273b3 100644
--- a/apps/emqx/src/emqx_schema.erl
+++ b/apps/emqx/src/emqx_schema.erl
@@ -923,7 +923,7 @@ fields("sysmon") ->
     [ {"vm",
        sc(ref("sysmon_vm"),
           #{ desc => "This part of the configuration is responsible for collecting
- BEAM VM events, such as long garbage collection, traffic congesiton in the inter-broker
+ BEAM VM events, such as long garbage collection, traffic congestion in the inter-broker
  communication, etc."
            })
       }