Repository navigation
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🔵 Needs a closer look
The companion appearance-controls PR must merge first, and the resulting UI, documentation and shared-file resolutions need human verification.
1 open issue
What changed in this PR
Refreshes the bundled manual for the Cacti-maintained Weathermap plugin and makes local documentation easier to reach, addressing #322 and the documentation-access goal of #102.
Changes:
- Replaces outdated setup and editor guidance with current workflows, examples and responsive styling.
- Adds themed Docs shortcuts in the viewer and management page without changing editing permissions.
- Adds documentation-link, navigation and rendered-example regression checks.
| File | Description |
|---|---|
| weathermap-cacti-plugin.php | Adds the map-heading Docs shortcut. |
| weathermap-cacti-plugin-mgmt.php | Adds Docs after Rebuild All. |
| tests/Unit/DocumentationLinksTest.php | Runs documentation regression checks. |
| tests/Support/DocumentationReferenceVariants.conf | Exercises documented syntax and defaults. |
| tests/Support/DocumentationNavigationRegression.php | Checks Docs access and management permissions. |
| tests/bin/render-doc-examples.php | Validates rendered examples and generates illustrations. |
| tests/bin/check-doc-links.php | Checks local HTML targets and anchors. |
| README.md | Points readers to the refreshed manual. |
| locales/po/cacti.pot | Updates editor text and adds Docs translation entry. |
| lib/editor.inc.php | Replaces the outdated editor introduction. |
| docs/pages/upgrading.html | Adds backup, migration and verification guidance. |
| docs/pages/main.html | Introduces current map creation and basic concepts. |
| docs/pages/install-cli.html | Clarifies Cacti-based command-line requirements. |
| docs/pages/install-cli-editor.html | Distinguishes the former standalone editor. |
| docs/pages/install-cacti.html | Updates installation and filesystem permissions. |
| docs/pages/install-cacti-editor.html | Explains integrated editor setup. |
| docs/pages/faq.html | Updates troubleshooting for current workflows. |
| docs/pages/editor.html | Documents editor controls and Undo/Redo. |
| docs/pages/cli-reference.html | Refreshes options and export limitations. |
| docs/pages/cacti-plugin.html | Explains registration, viewing and management. |
| docs/pages/appearance.html | Adds appearance and image-library guidance. |
| docs/manual.css | Provides self-contained responsive manual styling. |
| docs/index.php | Redirects directory access to the manual. |
| docs/index.html | Reorganizes the manual landing page. |
| docs/images/reference-traffic-pulse-2.0.svg | Illustrates directional high-load pulsing. |
| docs/example/traffic-pulse-2.0.conf | Supplies fixed-data pulse example. |
| docs/example/label-positions-2.0.conf | Demonstrates node-label placement. |
| docs/example/graph_page.html | Adds historical graph alternative text. |
| docs/example/editor-settings-2.0.conf | Demonstrates backgrounds, notes and defaults. |
| docs/example/curved-comments-2.0.conf | Compares straight and curved comments. |
| docs/example/combined-sources-2.0.conf | Demonstrates summed traffic sources. |
| docs/editor-workflow.md | Links workflows to the maintained manual. |
| css/weathermap.css | Styles the viewer Docs shortcut. |
| CHANGELOG.md | Records documentation and Docs-access changes. |
Review effort: Balanced
Comment on lines
+38
to
+39
| the same thing with the default KILO 1000. An existing link with its own capacity keeps | ||
| that value when you change the defaults.</p> |
|
bmfmancini
approved these changes
Oct 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Refresh the bundled 0.98a-era manual for the Cacti-maintained plugin and the upcoming 2.0.1 changes. The guides cover installation/upgrades, map creation and registration, the editor toolbar, node/link properties, primary and additional measurements, hover previews, uploads, notes, Undo/Redo, appearance and troubleshooting.
Retain the original technical references, their topic anchors, all 22 distinct configuration-reference illustrations and historical release notes. Add current syntax/defaults/examples, compact screenshots using generic maps, rendered configuration examples, responsive navigation and a self-contained stylesheet. Correct outdated setup guidance and the inherited font example, retain the old misspelled error-code anchor as an alias, and add accessible descriptions to the historical sample images and hotspots.
Add a themed Docs link at the right of the map heading and a matching Docs button after Rebuild All in management. Both open the local manual in a new tab; management permissions continue to control editing shortcuts. Update README and the editor's outdated introductory message. Load the shared heading helper directly in regression tests rather than evaluating extracted source code.
Closes #322. Related to #102; this adds viewer/management documentation access rather than per-field help links.
Validation
Includes documentation issues followed by the Docs-access feature under the upcoming 2.0.1 changelog section. No release version bump. Optional integrations and the full legacy command-line/database path have not all been exercised end to end.
The guide documents the existing Map Properties capacity-editing limitation: when either direction matches its old default, changing map capacity can replace both directions. It advises checking and restoring asymmetric values; this PR does not alter that legacy algorithm.
Merge order
Merge #323 first: the manual and screenshots describe those 2.0.1 controls. The two PRs share the changelog and translation template, so retain both sets of entries if resolving overlap.
Screenshot
Generic viewer example used in the manual (fixed demonstration readings):