Skip to content

docs: fix SQL syntax error, stale version references, and prose errors in misc files#222

Merged
netniV merged 1 commit intoCacti:developfrom
somethingwithproof:fix/prose-sql-stale-docs
Mar 11, 2026
Merged

docs: fix SQL syntax error, stale version references, and prose errors in misc files#222
netniV merged 1 commit intoCacti:developfrom
somethingwithproof:fix/prose-sql-stale-docs

Conversation

@somethingwithproof
Copy link
Contributor

@somethingwithproof somethingwithproof commented Mar 9, 2026

Fix SQL syntax error in Boost.md: both ALTER TABLE statements had a trailing comma after the table name, breaking copy-paste.

Remove two stale MySQL settings from Requirements.md: table_cache (renamed to table_open_cache in MySQL 5.1.3) and innodb_file_io_threads (removed in MySQL 5.5, superseded by innodb_read/write_io_threads already documented in the same file).

Remove Debugging.md 'Miscellaneous' section referencing Cacti 0.8.6h and 'upcoming 0.9' (~18 years old); the issue it described was fixed before 1.0.

Fix prose errors in Boost.md, Principles-of-Operation.md, Contributing-Translations.md, and Standards-Security.md. See commit message for full list.

Update Cacti-SSL-Configuration.md: RSA key size 2048 -> 4096; fix 'HTTP' label in description text.

Copilot AI review requested due to automatic review settings March 9, 2026 09:39
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This documentation PR fixes a range of issues: a critical SQL syntax error (trailing comma on ALTER TABLE), stale MySQL variable references (table_cache renamed to table_open_cache, innodb_file_io_threads removal), removal of misleading pre-0.9 Cacti legacy content from Debugging.md, SSL certificate improvements (RSA key size 2048→4096 bits), and dozens of prose/spelling corrections across many files. It also adds several new files (new template docs, conversion guide, scripts) and modernizes existing shell scripts.

Changes:

  • Fix SQL syntax, remove stale MySQL variables, and remove misleading legacy debug section in Requirements.md and Debugging.md
  • SSL config update: RSA key 4096 bits, HTTP→HTTPS comment, Let's Encrypt recommendation
  • Widespread prose/spelling fixes, copyright year updates (2022→2026), and new documentation files

Reviewed changes

Copilot reviewed 129 out of 152 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
Requirements.md table_cachetable_open_cache (with note); innodb_file_io_threads removed
Debugging.md Stale Cacti 0.8.6h "poller_output" section removed
Cacti-SSL-Configuration.md Key size 2048→4096, "HTTP"→"HTTPS" label, Let's Encrypt note added
Standards-Security.md OS command injection section added; "the the" and "invalidate" fixed
Principles-of-Operation.md Multiple prose fixes (principle→principles, resiliant→resilient, etc.)
Contributing-Translations.md "sigining up" → "signing up"
template_apache_config.md New file — Apache template config for CentOS and Debian
template_esxi_config.md New file — ESXi SNMP configuration guide
supported-plugins.md New file — list of Cacti Group–supported plugins
device-template-specific-proxmox.md New file — Proxmox external storage guide
convert-from-package-to-source-debian-ubuntu.md New file — package-to-source migration guide
bin/copyright_year.sh New utility to bulk-update copyright years
bin/check_missing_link.sh, bin/check_markdown_style.sh, bin/build_html_docs.sh Shell script modernization (backtick→$(), quoting)
resource/xml/query_interface_traffic.php License header added, trailing whitespace removed
resources/unused_images.sh Modernized (grep -c, $(…))
.travis.yml Removed (CI migration)
~60 other .md files Copyright year 2022→2026; whitespace/formatting cleanup

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

# ESXi/VMWare Template

The ESXi template uses snmp, so ESXi must have SNMP configured correctly.
You can use ESXCLI commands directly on tge host using the ESXi Shell
Copy link

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: "tge" should be "the" in the sentence "You can use ESXCLI commands directly on tge host using the ESXi Shell".

Copilot uses AI. Check for mistakes.
Comment on lines +29 to +43
Enable the apcache2 `status` module:

Place the below config into a new file (eg, 80-server-status.conf) within
`/etc/apache2/conf-available`

```console
ExtendedStatus On

<Location /server-status>
SetHandler server-status
Require local
</Location
```

Then use the following commands to enable the `stauts` module and new
Copy link

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two spelling errors in the Debian section of this new file: "apcache2" (line 29) should be "apache2", and "stauts" (line 43) should be "status".

Copilot uses AI. Check for mistakes.
@somethingwithproof somethingwithproof changed the base branch from main to develop March 9, 2026 17:43
@somethingwithproof somethingwithproof force-pushed the fix/prose-sql-stale-docs branch from 719f4d4 to 82c4987 Compare March 10, 2026 20:57
@netniV netniV merged commit 21981b3 into Cacti:develop Mar 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants