Skip to content

fix(wiki): update pricing/bundle docs, backup retention, compose storage, env vars, link audit (D-1289, D-0692, D-0659, D-0726, D-0717) - #997

Open
acamarata wants to merge 4 commits into
mainfrom
dw9-cli-1
Open

acamarata wants to merge 4 commits into
mainfrom
dw9-cli-1

Conversation

@acamarata

Copy link
Copy Markdown
Collaborator

Summary

Fixes five open technical-debt rows in the cli wiki and tooling.

D-1289: stale pricing/tier pages

Rewrote Licensing-Guide, Feature-Plugins, Plugin-Licensing, Plugin-Overview and cmd-bundle bundle tables from the live VMI offering at plugins.nself.org/bundles.json. Removed Basic/Pro/Elite/Business tier references and planned-v1.1.0 statuses; pages now point to nself.org/pricing as the authoritative source.

D-0692: Compose-Generation MinIO-only description

Updated Service Generation Order to describe both v1.4 (minio + init) and v1.5 (seaweedfs + seaweedfs-init) object storage modes, noting that MinIO in v1.5 requires nself add minio and fails with E138 when seaweedfs is present. Linked Object-Storage.md.

D-0659: undocumented NSELF_PLUGIN_REGISTRY

Added one table row to Config-Env-Vars.md documenting the variable, its default (https://plugins.nself.org), and the commands that read it.

D-0726: missing keep-tag prune hold and strict restore

Added a Retention and Prune Holds section to Guide-Backup-Restore.md explaining that keep/keep-* tagged backups survive prune, how to release them, and that keep-stack-* restores run in strict mode.

D-0717: broken docs links and .claude paths

Replaced 19 cli/blob/main/.claude links with inline descriptions and fixed 8 broken nself.org/docs/ links to wiki-internal anchors. Added auditProseLinks to tools/wikigen/main.go so -check fails on any future .claude/ or unlisted nself.org/docs/ link.

D-0636: Release-Process.md

ALREADY-FIXED — the current page already documents S2 admin lockstep, S6 homebrew PR + rerun, S10 Go SDK tag, and S7 Latest-slot check per the v1.4.13 evidence.

Verification

  • go build -mod=vendor ./tools/wikigen: OK
  • ./wikigen -check: All 21 wiki command pages are current.
  • No test files were changed; doc-only fixes verified by wikigen check passing.

@acamarata

Copy link
Copy Markdown
Collaborator Author

Rebased onto origin/main (no conflicts). Wikigen check passes: all 21 wiki command pages are current. Force-pushed to dw9-cli-1.

@acamarata

Copy link
Copy Markdown
Collaborator Author

nself-ci failed on go-test: TestParityMatrixIsCurrent (internal/repoqa). The D-0659 change documents NSELF_PLUGIN_REGISTRY, so .github/surface-parity.{md,json} went stale. Rebased onto origin/main and regenerated with make parity in 6f04072. Before: the test fails on the PR head with 'surface-parity.md is stale'. After: repoqa, wikigen and parity packages pass (173 tests). No review findings were attached to the request, so this is the only defect I found.

@acamarata

Copy link
Copy Markdown
Collaborator Author

Review fixes pushed (7d883aa).

  • Guide-Backup-Restore: removed the nonexistent nself backup tag --rename and the invented strict-mode/--force text. Retention now documents what internal/backup/prune.go does: tiered daily/weekly/monthly (BACKUP_RETENTION_DAILY/WEEKLY/MONTHLY, --keep-* flags; systemd.go:105 passes the same flags). BACKUP_RETENTION_DAYS is legacy and prune does not read it. Releasing a keep-* hold is a manual file rename (no tag command exists).
  • Wikilinks: cmd-template-publish bullet dropped (no page); bundle-nsentry -> cmd-sentry; bundle-ntask -> Bundles. The two [[Guide-Migration]] hits sat inside code fences quoting CLI output (build.go/start.go and update_release_api.go print the nself.org/docs URL), so they now show the real URL again. Also fixed [[SDK-Reference]] (no page, line removed) and [[Monitoring]] -> [[monitoring]], which the new check found.
  • auditProseLinks moved to tools/wikigen/audit.go: resolves wikilink targets on every wiki page (basename, anchors/pipes/.md ignored, fences and inline code skipped, matching scripts/ci/wiki-link-audit.sh); .claude and nself.org/docs checks stay on cmd-* pages, docs URLs in fenced CLI output are skipped. Allowlist is exactly the four URLs (commands, plugins, guides, reference), now tested. Tests in audit_test.go: the broken-wikilink and scope tests fail on the previous function and pass now.
  • wikigen -check, wiki-link-audit.sh (LC_ALL=C), flag-drift audit and go test ./tools/... pass.
  • Note: the branch is 11 commits behind main; main's wiki-link-audit.sh adds LC_ALL=C, without which the script reports ~200 false positives locally. The runtime still prints the nself.org/docs/migrate/from-v0.9 URL; whether that page exists is a separate CLI/docs question.

@acamarata

Copy link
Copy Markdown
Collaborator Author

Fixed the review finding on retention docs: the doc was right about intent, the code was wrong. backup prune read the --keep-* flags directly, and their non-zero defaults (7/4/12) always won, so BACKUP_RETENTION_DAILY/WEEKLY/MONTHLY never applied. New pruneRetention (cmd/commands/backup_verify_prune.go) uses an explicit flag first, then config, then the flag default. Test TestPruneRetention fails against the old behaviour (got 7/4/12, want 14/8/24) and passes now. Commit 3337287. Doc left as written. Docker-dependent tests were not run.

This branch has not been deployed

No deployments
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