Split FOG 1.5 and 1.6 documentation - #160
Merged
Merged
Conversation
Adds docs/1.5/ for the 31 pages where FOG 1.5 and 1.6 genuinely diverge (PKI/Secure Boot architecture, plugins, LDAP, site scoping, CSV format, installer flags, .fogsettings keys, and more), each grounded in fogproject's dev-branch source rather than the existing docs' own framing. The other ~90 pages that don't differ stay shared. Every forked pair cross-links to its counterpart; the 1.6-side pages keep their content but point to the 1.5 version where one exists. Site-wide, wikilinks to the 31 now-ambiguous basenames are path-qualified, since a bare link would otherwise resolve through a context_id alias-redirect stub instead of the real page, silently dropping any #anchor. Legacy `!!!` mkdocs admonition syntax was converted to Obsidian callouts in every file touched. Also rewrites development/version-sync-automation.md, which had drifted since GH-1510/GH-1513 replaced the tracked-file FOG_VERSION stamp with a generated, gitignored packages/web/commons/version.php. Co-Authored-By: Claude <noreply@anthropic.com>
5 tasks
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.
Summary
Adds
docs/1.5/for the 31 pages where FOG 1.5 and 1.6 genuinely differ — PKI/Secure Boot architecture, plugins, LDAP, site scoping, host CSV format, installer flags,.fogsettingskeys, reports, storage nodes, and a handful of API/troubleshooting pages. The other ~90 pages that don't differ between versions stay shared, unforked.Every forked pair cross-links to its counterpart via a top-of-page callout. A new "FOG 1.5" pill sits in the sidebar next to Installation/Management/Knowledge Base/Development.
Each 1.5 page is grounded in
fogproject'sdev-branchsource, not just adapted from the existing docs' framing — that framing turned out to be wrong in a few places (see below).Real findings from grounding this in source
httpproto=https. Documented as explicit danger callouts.csv_import_export.md's "new in FOG 1.6" claim was false — generic CSV import/export has existed since ~2017; what's actually new in 1.6 is header-row support, the associations column, and FK name resolution. Fixed on the 1.6 page.primary-mac-address-issues.mdpage's direct-SQL fix usedset primary="1"instead of the actual column namehmPrimary— fixed on both pages.pingstatuscolumn that import expects — documented as a warning on the 1.5 page.dev-branchin July 2026 — corrected.Mechanical cleanup that came with the split
Because
docs/1.5/.../<name>.mdanddocs/.../<name>.mdnow share 31 basenames, every wikilink to one of them had to be fully path-qualified — a bare[[name]]resolves through acontext_idalias-redirect stub instead of the real page, which silently drops any#anchoron the link (a failure mode this repo's own CLAUDE.md already documents). Fixed site-wide, not just in the forked pages. Also converted legacy!!!mkdocs admonition syntax to Obsidian callouts in every file touched.docs/development/version-sync-automation.mdis separately rewritten — it had drifted since GH-1510/GH-1513 replaced the tracked-fileFOG_VERSIONstamp with a generated, gitignoredpackages/web/commons/version.php. Verified against the current.githooks/scripts and the mergedfog-workflows#39. Also flags thatdev-branchhasn't received the generated-file port yet, so it's still on the old mechanism.Test plan
npm run docs:build— clean, no broken/literal[[wikilinks (verified against the full built HTML, not just per-batch)node --test "scripts/*.test.mjs"— 51/51 passcontext_ids across the siteCo-Authored-By: Claude noreply@anthropic.com