From d55e1a674f5f1f452503884aa5a36e2f937eff5f Mon Sep 17 00:00:00 2001 From: Clement Tsang <34804052+ClementTsang@users.noreply.github.com> Date: Fri, 29 Aug 2025 23:27:26 -0400 Subject: [PATCH] docs: fix missing pages + delete old filtering page (#1806) --- .../config-file/data-filtering.md | 46 ------------------- .../configuration/config-file/disk-table.md | 34 +++++++++++++- docs/mkdocs.yml | 6 ++- 3 files changed, 36 insertions(+), 50 deletions(-) delete mode 100644 docs/content/configuration/config-file/data-filtering.md diff --git a/docs/content/configuration/config-file/data-filtering.md b/docs/content/configuration/config-file/data-filtering.md deleted file mode 100644 index 478996dc..00000000 --- a/docs/content/configuration/config-file/data-filtering.md +++ /dev/null @@ -1,46 +0,0 @@ -# Data Filtering - -!!! Warning - - This section is in progress, and is just copied from the old documentation. - -You can hide specific disks, temperature sensors, and networks by name in the config file via `disk.name_filter` and `disk.mount_filter`, `temperature.sensor_filter`, and `network.interface_filter` respectively. Regex (`regex = true`), case-sensitivity (`case_sensitive = true`), and matching only if the entire word matches (`whole_word = true`) are supported, but are off by default. Filters default to denying entries that match and can be toggled by setting `is_list_ignored` to `false` in the config file. - -For example, here's the disk widget with no filter: - -![Disk no filter](../../assets/screenshots/config/disk-filtering/disk_no_filter.webp) - -The following in the config file would filter out some entries by disk name: - -```toml -[disk.name_filter] -is_list_ignored = true -list = ["/dev/sda"] -regex = true -case_sensitive = false -whole_word = false -``` - -![Disk widget with just disk name filter](../../assets/screenshots/config/disk-filtering/disk_name_filter.webp) - -If there are two potentially conflicting filters (i.e. when you are using both a disk and mount filter), the filter that explicitly allows an entry takes precedence over a filter that explicitly denies one. So for example, let's say we set a disk filter accepting anything with `/dev/sda`, but deny anything with `/mnt/.*` or `/`. So to do so, we write in the config file: - -```toml -[disk.name_filter] -is_list_ignored = false -list = ["/dev/sda"] -regex = true -case_sensitive = false -whole_word = false - -[disk.mount_filter] -is_list_ignored = true -list = ["/mnt/.*", "/"] -regex = true -case_sensitive = false -whole_word = true -``` - -This gives us: - -![Disk widget with disk name and mount filter](../../assets/screenshots/config/disk-filtering/disk_name_mount_filter.webp) diff --git a/docs/content/configuration/config-file/disk-table.md b/docs/content/configuration/config-file/disk-table.md index bc624370..99fb7676 100644 --- a/docs/content/configuration/config-file/disk-table.md +++ b/docs/content/configuration/config-file/disk-table.md @@ -16,7 +16,11 @@ You can filter out what entries to show by configuring `[disk.name_filter]` and you can set a list of things to filter with by setting `list`, and configure how that list is processed with the other options. -For example, here we are ignoring any entry with a name that matches `/dev/sda`, or specifically `/dev/nvme0n1p2`. +For example, consider a disk widget showing these entries: + +![Disk no filter](../../assets/screenshots/config/disk-filtering/disk_no_filter.webp) + +If we wanted to ignoring any entry with a name that matches `/dev/sda`: ```toml [disk.name_filter] @@ -24,7 +28,7 @@ For example, here we are ignoring any entry with a name that matches `/dev/sda