docs: fix SQL syntax error, stale version references, and prose errors in misc files#222
Conversation
There was a problem hiding this comment.
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_cache → table_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 |
There was a problem hiding this comment.
Typo: "tge" should be "the" in the sentence "You can use ESXCLI commands directly on tge host using the ESXi Shell".
| 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 |
There was a problem hiding this comment.
Two spelling errors in the Debian section of this new file: "apcache2" (line 29) should be "apache2", and "stauts" (line 43) should be "status".
Refs Cacti#222 Signed-off-by: Thomas Vincent <[email protected]>
719f4d4 to
82c4987
Compare
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 totable_open_cachein MySQL 5.1.3) andinnodb_file_io_threads(removed in MySQL 5.5, superseded byinnodb_read/write_io_threadsalready 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.