Skip to content

Publish current PDF, text, and contributed manual replacements - #254

Open
somethingwithproof wants to merge 12 commits into
docs/refresh-html-manualfrom
docs/current-manual-replacements
Open

somethingwithproof wants to merge 12 commits into
docs/refresh-html-manualfrom
docs/current-manual-replacements

Conversation

@somethingwithproof

@somethingwithproof somethingwithproof commented Oct 27, 2026 •

Copy link
Copy Markdown
Member

The published PDF/text manuals and contributed installation guides describe historical Cacti versions. This adds current replacements while preserving the original archive URLs, contributor credits, and rights notices.

  • Publish the complete Cacti development PDF and UTF-8 text manual, plus German, Turkish, Linux, Russian UNIX/Windows, Windows, Solaris migration, and database-schema editions. Label every current edition as unreleased Cacti 1.3.
  • Keep the localized introductions separate from their complete English appendices. These are new guides, not full translations or updates attributed to the original contributors. Explain the current Windows dependency restriction and use a migration procedure for Solaris.
  • Record source hashes, output checksums, locked tooling, 11 archived originals, and the pinned upstream schema revision. The schema reference includes all 127 base tables and excludes seed data and upgrade commands.
  • Reuse the maintained manual content and existing documentation styles. Include populated historical graph screenshots and a real rendered PDF preview in CI artifacts.

Validation: 6 edition-helper tests, 19 HTML-renderer tests, and 2 navigation regression tests pass, with 100% line and branch coverage for those two helpers. Real publication checks validate all 9 PDF/text editions, source/output hashes, complete selected chapters, internal PDF links, and non-English cover text. Browser E2E tests render 217 HTML pages and preserve all 75 legacy routes and 313 bookmarks. The local main PDF contains 136 chapters across 516 pages; pagination can vary with native fonts/libraries. Markdown, spelling, and workflow checks pass.

Builds on #253, which carries the updated chapters and HTML publication workflow. Reuses the PDF tooling prepared for #250 without changing that PR's branch; its query examples and separate ReportIt work remain outside this PR. CI uploads current manuals, manifests, coverage, and previews for 14 days. Publishing to the public file host remains a maintainer deployment step; archive files should keep their existing names and notices.

Native stack registration attempted with gh stack link --base develop 248 252 253 254. GitHub rejected it because #248 has auto-merge enabled. That setting is preserved. The PR base chain remains #248 → #252 → #253 → #254; body links are not a substitute for native stack registration.

Sonar duplication analysis excludes only the pinned upstream schema SQL and its deliberately generated DDL reference. Authored code remains in duplication analysis and the project thresholds are unchanged. Navigation heading parsing also avoids the previously flagged ambiguous regex.

Hosted validation passes at 55aa975: complete HTML/browser publication, PDF/text edition publication, and both Sonar checks. The browser suite also verifies the language declarations of all four localized HTML guides.

Downloaded artifacts were checked after upload: ZIP integrity and SHA-256, every manual output checksum, both 100% helper coverage reports, all 5 browser cases, and the populated PDF preview. The hosted Linux main PDF has 529 pages; its 136 chapters match the local build despite font-dependent pagination.

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
…itions

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
…irectly

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
@sonarqubecloud

Copy link
Copy Markdown

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.

1 participant