docs: comprehensive validation audit, Spine poller overhaul, and technical refactor

.github/ISSUE_TEMPLATE/bad_link.md

@@ -8,7 +8,7 @@ assignees: ''
 ---
 <!--
  #
- # Copyright (C) 2004-2024 The Cacti Group
+ # Copyright (C) 2004-2026 The Cacti Group
  #
 -->
 # Describe the link

.github/ISSUE_TEMPLATE/bug_report.md

@@ -8,7 +8,7 @@ assignees: ''
 ---
 <!--
  #
- # Copyright (C) 2004-2024 The Cacti Group
+ # Copyright (C) 2004-2026 The Cacti Group
  #
 -->
 # Describe the bug

.github/ISSUE_TEMPLATE/feature_request.md

@@ -8,7 +8,7 @@ assignees: ''
 ---
 <!--
  #
- # Copyright (C) 2004-2024 The Cacti Group
+ # Copyright (C) 2004-2026 The Cacti Group
  #
 -->
 # Feature Request

Aggregate-Templates.md

@@ -39,7 +39,7 @@ references can be used in the `Prefix` section in order to uniquely identify the
 **Graph Item**.
 
 There are several `Graph Types` transformations that deal with how `AREA`,
-`LINEX` and `STACK` items are handled in the resulting **Aggeregate Graph**,
+`LINEX` and `STACK` items are handled in the resulting **Aggregate Graph**,
 they include:
 
 - **Keep Graph Types** - No transformation will occur. All `AREA`, `LINE`, and

CDEFs.md

@@ -3,7 +3,7 @@
 ## Background
 
 CDEF's in Cacti are a one to one analog to CDEF's in RRDtool.  Cacti
-simply provides and interface to create and manage them.  Once the
+simply provides an interface to create and manage them.  Once the
 CDEF's are created in Cacti they can be imported and exported globally.
 
 CDEF's are mathematical formulas that either modify the numeric data from
@@ -12,7 +12,7 @@ one to many data sources or VNAMES that you have in your **Graph Template**.
 The format of the mathematical formulas is called Reverse Polish Notation (RPN).
 RPN was and is an early form of how Engineers entered equations into early
 HP and other Calculators to solve Engineering problems.  The reason we still
-use it today, is that it follows a simple Stack principle.  In other words,
+use it today is that it follows a simple Stack principle.  In other words,
 it's not broken.
 
 CDEF's can get very complex as there are several mathematical functions
@@ -36,49 +36,55 @@ When you Click on the CDEF's name, you will enter into an Edit screen.  From the
 you will see an ordered list of your Stack.  It normally will begin with something
 like the CURRENT_DATA_SOURCE which means that when you Add a **Graph Item** to
 either a **Graph Template** or **Graph**, you can select a CDEF.  The
-**Data Source** associated with that **Graph Items** is the CURRENT_DATA_SOURCE.
+**Data Source** associated with that **Graph Item** is the CURRENT_DATA_SOURCE.
 
-After that, you may see a numeric number, followed by a math operator.  That the
+After that, you may see a number, followed by a math operator.  That is the
 simplest form of a CDEF.  If you have drag & drop enabled, you can re-order the
 CDEF items using drag & drop.  Otherwise you will see arrows that allow you
 to move the CDEF Items up and down.
 
 ![CDEFs Edit](images/cdefs-edit1.png)
 
 When editing a CDEF, the first decision is what Type of Data you want to put on
-the Stack, you options as shown in the image below.  They include:
+the Stack.  Your options are shown in the image below.  They include:
 
 Name | Description
 --- | ---
 Function | A mathematical function that we will describe below
 Operator | Common mathematical operators including (+, -, *, /, and %)
 Another CDEF | Another Cacti CDEF.  That could be confusing
+Special Data Source | A value drawn from the Graph, the Data Source, or the poller, described below
 Custom String | Something like a number, a 'U' or 'Nan' for example
 
 ![CDEFs Item Type Edit](images/cdefs-edit3.png)
 
 ## Special Data Sources
 
-In this next Image, you will find a CDEF Item in the process of being added.  Note
+In this next image, you will find a CDEF Item in the process of being added.  Note
 that when you pick `Special Data Source` you have a drop-down that appears with
 the flavor of `Special Data Source`.  There are many.  They include:
 
 Name | Description
 --- | ---
 Current Graph Item Data Source | The value of the Data Source associated with the Graph Item
 Current Graph Item Polling Interval | This value is otherwise known as the Step in RRDtool terminology
-All Data Sources (No Dupes) | The total of all Data Sources removing any duplicate DEF's
-All Data Sources (With Dupes) | Add the values from all the Data Sources whether or not they are duplicated
-All Similar Data Sources (No Dupes) | Means all Data Sources with the same RRDtool Data Source name like traffic_in, and traffic_out
-All Similar Data Sources (No Dupes) Poller Interval | The max of the poller intervals returned from all similar Data Sources
+All Data Sources (Do not Include Duplicates) | The total of all Data Sources removing any duplicate DEF's
+All Data Sources (Include Duplicates) | Add the values from all the Data Sources whether or not they are duplicated
+All Similar Data Sources (Do not Include Duplicates) | Means all Data Sources with the same RRDtool Data Source name like traffic_in, and traffic_out
+All Similar Data Sources (Do not Include Duplicates) Polling Interval | The max of the poller intervals returned from all similar Data Sources
+All Similar Data Sources (Include Duplicates) | Add the values from all similar Data Sources whether or not they are duplicated
 Current Data Source Item: Minimum Value | The RRDtool minimum value of the Current Data Source
 Current Data Source Item: Maximum Value | The RRDtool maximum value of the Current Data Source
+Current Data Source Item: Least Squares Line Function | The RRDtool LSLINT, LSLSLOPE and LSLCORREL set as a least squares line
+Current Data Source Item: Least Squares Line Y-intercept | The y-intercept of the least squares line for the Current Data Source
+Current Data Source Item: Least Squares Line Slope | The slope of the least squares line for the Current Data Source
+Current Data Source Item: Least Squares Line Correlation Coefficient | The correlation coefficient of that least squares line
 Graph: Lower Limit | The lower Limit of the Graph
 Graph: Upper Limit | The upper Limit of the Graph
-Count of All Data Sources (No Dupes) | The total count of all Data Sources without Duplication
-Count of All Data Sources (With Dupes) | The total count of all Data Sources including Duplicates
-Count of Similar Data Sources (No Dupes) | The total count of Data Sources with the same RRDtool Data Source Name
-Count of Similar Data Sources (With Dupes) | The total count of Data Sources with the same RRDtool Data Source Name
+Count of All Data Sources (Do not Include Duplicates) | The total count of all Data Sources without Duplication
+Count of All Data Sources (Include Duplicates) | The total count of all Data Sources including Duplicates
+Count of All Similar Data Sources (Do not Include Duplicates) | The total count of Data Sources with the same RRDtool Data Source Name, counted once each
+Count of All Similar Data Sources (Include Duplicates) | The total count of Data Sources with the same RRDtool Data Source Name, including Duplicates
 
 As you can see there is quite a bit of information that can be pulled from
 RRDtool for performing Graphical manipulation of Data.
@@ -89,8 +95,8 @@ RRDtool for performing Graphical manipulation of Data.
 
 This list of CDEF functions is long and it's best to refer directly to the
 [RRDtool Manual](https://oss.oetiker.ch/rrdtool/doc/rrdgraph_rpn.en.html) for meanings
-and examples of their use.  Cacti supports all of them, if you find one that is not
-supported, open an [Issue on Github](https://github.com/Cacti/cacti/issues).
+and examples of their use.  Cacti supports most of them.  If you find one that
+is not supported, open an [Issue on GitHub](https://github.com/Cacti/cacti/issues).
 
 ---
 Copyright (c) 2004-2026 The Cacti Group

Cacti-Log.md

@@ -2,8 +2,9 @@
 
 ## Summary
 
-The Cacti Log is where all Cacti statistics, warnings, errors and other log messages
-are sent to. Cacti can optionally log some information to your syslog or event log
+The Cacti Log is where all Cacti statistics, warnings, errors and other log
+messages are sent. Cacti can optionally log some information to your syslog or
+event log
 depending on your OS type.
 
 The Cacti Log is by default ordered from newest event to oldest event, and
@@ -24,46 +25,51 @@ An image of the Cacti Log file can be seen below.
 
 ## Cacti Log Filters
 
-What we like to see in the Cacti Log is a lot of Green, which means good. By default,
+What we like to see in the Cacti Log is a lot of Green, which means good. By
+default,
 WARNINGS are yellow, and ERRORS are red. But there are other types of messages
 that highlight differently. Generally, you can filter for these message types.
 The filters include:
 
-- **File** - The Cacti Log file to view. They are suffixed by a data when they were rotated
-  using the following pattern: YYYY-MM-DD.
+- **File** - The Cacti Log file to view. Rotated files are suffixed with the
+  date they were rotated, using the pattern YYYY-MM-DD.
 - **Tail Lines** - The number of lines to view from the selected Cacti Log.
 - **Types** - The message types to view. These will be explained below.
-- **Display Order** - The order to display the Log lines, either *Newest First* or *Oldest First*.
+- **Display Order** - The order to display the Log lines, either *Newest First*
+  or *Oldest First*.
 - **Refresh** - How often to Auto-refresh the interface.
-- **Search** - A perl compatible Regular Expression to search the log with.
+- **Search** - A Perl compatible regular expression to search the log with.
 
 The Cacti Log **Types** include the following:
 
 - **Stats** - Anything that includes the word **STATS**
 - **Warnings** - Anything that includes the word **WARNING**
-- **Warnings++** - Anything of each **WARNING**, **ERROR**, **DEBUG**, and **SQL**
-  this one is good for debugging, and it will include most important
-  errors to the Cacti Administrator.
+- **Warnings++** - Anything of each **WARNING**, **ERROR**, **DEBUG**, and
+  **SQL**. This one is good for debugging, and it includes the errors that
+  matter most to the Cacti Administrator.
 
 - **Errors** - Anything that includes the word **ERROR**
 - **Errors++** - Anything of each **ERROR**, **DEBUG**, and **SQL**
 - **Debug** - Anything that includes the word **DEBUG**
-- **AutoM8** - Anything that includes the word **AUTOM8**. These message come from
-              Cacti automation of Devices, Graphs, and Trees
+- **SQL Calls** - Anything that includes the word **SQL**
+- **AutoM8** - Anything that includes the word **AUTOM8**. These messages come
+  from Cacti automation of Devices, Graphs, and Trees
 - **Non Stats** - Anything that does not include the word **STATS**.
 - **Boost** - Anything that contains the word **BOOST**.
-- **Device Up/Down** - Any device Up/Down notification including t
-                       hose that come from *Thold* or *Monitor* Plugins.
+- **Device Up/Down** - Any device Up/Down notification, including those that
+  come from the *Thold* or *Monitor* plugins.
 - **Recaches** - Any Device Recache Events.
-- **Threshold** - If the *Thold* plugins is installed,
-                  any of it's threshold breach and restoration events.
+- **Security Issues** - Added in Cacti 1.3. Anything logged by Cacti's
+  security auditing.
+- **Threshold** - If the *Thold* plugin is installed, any of its threshold
+  breach and restoration events.
 
 ## Differences between User and Administrative Views
 
 As previously mentioned, the Cacti log has two permission levels,
 the User Permission level will not include the *Purge* button,
 and can have some information hidden from public view
-whereas the Administrative view includes all Log messages and a *Purge** button.
+whereas the Administrative view includes all Log messages and a *Purge* button.
 
 ---
 Copyright (c) 2004-2026 The Cacti Group

Color-Templates.md

@@ -10,20 +10,20 @@ So, for example, if your **Color Template** uses 8 differing **Colors**, and
 your **Aggregate Graph** includes 16 *Graph Items*, then each color will be used
 twice in the **Aggregate Graph**.
 
-Below, you can see the four standard **Color Templates**, you can see that you
-have the ability to either *Delete* or *Duplicate* the **Color Templates**.  As
-with other Cacti objects, you will not be allowed to *Delete* a **Color
-Template** in use.
+Below, you can see the four standard **Color Templates**.  From the Actions
+drop down you can *Delete*, *Duplicate*, or *Sync Aggregates* for the selected
+**Color Templates**.  As with other Cacti objects, you will not be allowed to
+*Delete* a **Color Template** in use.
 
 ![Color Templates](images/color-templates.png)
 
-In the image below, you can see the **Color Template** edit screen.  This simply
+In the image below, you can see the **Color Template** edit screen.  This simple
 screen allows you to add, remove and re-order colors in the list.
 
 ![Color Templates Edit](images/color-templates-edit1.png)
 
 Shown in the image below, only Cacti **Colors** are allowed to be selected for
-Aggregate **Color Templates**.  The **Color** drop down can by typed into if you
+Aggregate **Color Templates**.  The **Color** drop down can be typed into if you
 wish to search through the list of approximately 340 legacy and *Named Colors*.
 
 ![Color Templates Item Edit](images/color-templates-edit2.png)

Colors.md

@@ -1,18 +1,18 @@
 # Colors
 
-Colors in Cacti come in two types and used to maintain a list of colors that can
-be used in Cacti for **Graph Templates** and **Graphs**.
+Colors in Cacti come in two types.  They maintain a list of colors that can be
+used in Cacti for **Graph Templates** and **Graphs**.
 
-The first type are the legacy Cacti colors imported from earlier versions of
-Cacti. Starting with Cacti 1.0, Cacti started to support the concept of *Named
-Colors* which come from a well known dictionary of well defined colors.  *Named
-Colors* are read only in Cacti. While the legacy Cacti colors can be named as
-the Cacti administrator desires.
+The first type is the legacy Cacti colors imported from earlier versions of
+Cacti. Starting with Cacti 1.0, Cacti supports the concept of *Named Colors*,
+which come from a well known dictionary of well defined colors.  *Named Colors*
+are read only in Cacti, while the legacy Cacti colors can be named as the Cacti
+administrator desires.
 
 The image below shows a list of Cacti *Named Colors*.  You can see that there is
 a search bar and check boxes for showing just *Named Colors* or all colors, and
 another check box for showing Colors that are used in **Graph Templates** and
-*Graphs*.  You can not remove either the *Named Colors* or Colors that are in
+**Graphs**.  You can not remove either the *Named Colors* or Colors that are in
 use by either a **Graph Template** or **Graph**.
 
 ![Colors](images/colors.png)
@@ -24,9 +24,8 @@ Color hex value.
 
 ![Colors Edit](images/colors-edit1.png)
 
-Below, you can see the color picker that allows you to visually find the
-appealing color.  You can also use hex values that were previously supported in
-earlier Cacti version.
+Below, you can see the color picker that allows you to pick a color visually.
+You can also use the hex values that were supported in earlier Cacti versions.
 
 ![Colors Color Edit](images/colors-edit2.png)
 

Command-Line-Scripts.md

@@ -30,7 +30,7 @@ briefly.
 
 | Script                          | Category    | Description                                                                                                                                                              |
 | ------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| input_whitelist.php             | Maintenance | To to onboard new Data Input Methods when using Cacti in a high security environment where new Data Input Methods must always be vetted before enabling for general use. |
+| input_whitelist.php             | Maintenance | To onboard new Data Input Methods when using Cacti in a high security environment where new Data Input Methods must always be vetted before enabling for general use. |
 | poller_graphs_reapply_names.php | Maintenance | Allows selecting re-running of Cacti's suggested values engine for Graphs                                                                                                |
 | poller_reindex_hosts.php        | Maintenance | Batch method to re-index Cacti Devices                                                                                                                                   |
 | analyze_database.php            | Maintenance | Analyzes all Cacti tables rebuilding their index cardinality. Important to run after having added large numbers of Devices and Graphs to Cacti.                          |

Data-Collectors.md

@@ -76,7 +76,7 @@ serves as the master **Data Collector** performing key maintenance operations
 for the entire system.
 
 In the edit page below, you can see what options are available when editing the
-**Main Data Collector**.  It is important the the hostname used is resolvable
+**Main Data Collector**.  It is important that the hostname used is resolvable
 by the **Remote Data Collectors**.
 
 ![Data Collectors Edit Main](images/data-collectors-edit-main.png)

Data-Sources.md

@@ -68,9 +68,9 @@ may be interested in to view the Data sources in use
 
 ![device datasources](images/data-sources-per-device.png)
 
-You can also view Orphaned data sources in this view by setting Orphaned from
-All to Orphaned Orphaned data sources are where the graph has been deleted but
-the data source was not deleted
+You can also list orphaned data sources from this page by ticking the
+**Orphaned** filter checkbox. An orphaned data source is one whose graph was
+deleted while the data source itself was left behind.
 
 ---