Skip to content

Add ziti-cni to the product picker (standalone, draft docs) - #153

Open
loganlipscomb wants to merge 11 commits into
mainfrom
add-cni-draft-signed
Open

loganlipscomb wants to merge 11 commits into
mainfrom
add-cni-draft-signed

Conversation

@loganlipscomb

@loganlipscomb loganlipscomb commented Sep 10, 2026

Copy link
Copy Markdown

Summary

  • Registers ziti-cni as a new standalone product in packages/docusaurus-theme/src/products.ts, grouped under "Self-Hosted Open Source" alongside OpenZiti and zrok
  • Uses the generic NetFoundry icon (NF_LOGO) since ziti-cni doesn't have its own logo yet — matches the existing @netfoundry/docusaurus-theme styling already in use on the ziti-cni docs site itself
  • Picker link follows the same linkFor()/DOCS_BASE pattern as every other product (/docs/ziti-cni/intro)
  • Registers ziti-cni as a full unified-doc build spoke, following the same pattern used for zlan/data-connector/customer-connect:
    • build-docs.mjs: --ziti-cni-branch flag, cloneOrUpdate call, authUrl entry (reuses GH_ZITI_CI_REPO_ACCESS_PAT, same credential already shared by ziti-doc/zlan, no new secret needed), lint target
    • docusaurus.config.ts: BUILD_FLAGS.ZITICNI, remark mapping, webpack alias, static-asset exclusion, pages/docs-plugin blocks via ziti-cni's own docusaurus-plugin-ziti-cni-docs.ts
    • Default DOCUSAURUS_BUILD_MASK bumped 0x3FF0x7FF to include the new bit
  • Fixes scripts/vercel-ignore.sh to also always watch packages/docusaurus-theme, regardless of which single path a given Vercel project is configured to check — unified-doc-preview only watches unified-doc/, so a theme-only change (like the picker entry itself) was being silently skipped
  • Carries forward dovholuknf's build/linting updates and the token-triggered preview rebuild from the original PR

Corresponding ziti-cni content: superseded PR (https://github.com/netfoundry/ziti-cni/pull/9)

Status

Verified working end-to-end in a local build (picker entry renders, ziti-cni content builds and serves correctly at /docs/ziti-cni/...). Every commit on this branch passes GitHub signature verification.

Test plan

  • Vercel preview builds successfully and the product picker shows the new "ziti-cni" entry under Self-Hosted Open Source (confirmed locally)
  • Confirm the live preview clones and renders ziti-cni's actual docs content at /docs/ziti-cni/...
  • Share the working preview link with Edward and Dave for review

🤖 Generated with Claude Code

@docpreview-dovholuknf-test

docpreview-dovholuknf-test Bot commented Sep 10, 2026

Copy link
Copy Markdown

Documentation preview

Project Status Preview Commit Updated (UTC)
netfoundry/docusaurus-shared ✅ Ready · 3m40s Preview 1822cef Sep 15, 2026 3:58pm

@vercel

vercel Bot commented Sep 10, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
nf-theme-sandbox Ready Ready Preview Sep 15, 2026 3:55pm UTC
unified-doc-preview Ready Ready Preview Sep 15, 2026 3:55pm UTC

Request Review

loganlipscomb1-tech and others added 9 commits September 11, 2026 13:13
Adds ziti-cni to the product registry and both picker column arrays
(unified + subsite), grouped under "Self-Hosted Open Source" alongside
OpenZiti and zrok, using the generic NetFoundry icon since ziti-cni
doesn't have its own logo yet.

ziti-cni's docs aren't cloned into unified-doc's build (build-docs.mjs)
yet, so the picker link points at the draft docs branch directly
(https://github.com/netfoundry/ziti-cni/tree/lipscomb-cni-docs-draft/docusaurus,
PR netfoundry/ziti-cni#8) rather than a
/docs/ziti-cni/... path that would 404. Wiring the actual build
pipeline is a follow-up.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Per nf-style-guide.md's "Avoid em dashes" rule.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
build-docs.mjs / docusaurus.config.ts: add ziti-cni following the same
pattern as data-connector and customer-connect (branch flag, cloneOrUpdate,
BUILD_FLAGS bit, remark mapping, webpack alias, docs-plugin block via the
product's own docusaurus-plugin-ziti-cni-docs.ts). Reuses the existing
GH_ZITI_CI_REPO_ACCESS_PAT token, same as ziti-doc and zlan, rather than
introducing a new credential.

scripts/vercel-ignore.sh: also always check packages/docusaurus-theme,
regardless of which single path a given Vercel project was told to watch.
unified-doc-preview only watches unified-doc/, so a theme-only change (like
the product-picker entry in this same branch) was being silently skipped.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
lipscomb-cni-docs-draft (PR #8) was superseded by lipscomb-cni-docs-draft-signed
(PR #9) after the commit-signing fix, but this default was never updated —
the preview build was silently fetching stale, superseded content.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
No changes here — just re-triggering unified-doc-preview so it re-clones
ziti-cni's lipscomb-cni-docs-draft-signed branch and picks up the manifest
build-time embedding feature (remark-embed-manifest.ts / real zitinetwork.yaml
content per platform).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
ziti-cni's build-time manifest-embedding plugins (remark-embed-manifest.ts /
docusaurus-plugin-copy-manifests.ts) have been fully reverted on
lipscomb-cni-docs-draft-signed (commit cd22a23), since they broke this
repo's unified-doc-preview build once cloned in. Re-triggering now that the
suspected-problematic code is gone.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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.

3 participants