Add ziti-cni to the product picker (standalone, draft docs) - #152
Open
loganlipscomb wants to merge 5 commits into
Open
Add ziti-cni to the product picker (standalone, draft docs)#152loganlipscomb wants to merge 5 commits into
loganlipscomb wants to merge 5 commits into
Conversation
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 https://github.com/netfoundry/ziti-cni/pull/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>
|
Documentation preview
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Per nf-style-guide.md's "Avoid em dashes" rule. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This reverts commit cb2e6ea.
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>
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
2 participants
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
ziti-cnias a new standalone product inpackages/docusaurus-theme/src/products.ts, grouped under "Self-Hosted Open Source" alongside OpenZiti and zrokNF_LOGO) since ziti-cni doesn't have its own logo yet — matches the existing@netfoundry/docusaurus-themestyling already in use on the ziti-cni docs site itselflinkFor()/DOCS_BASEpattern as every other product (/docs/ziti-cni/intro) — the earlier draft-branch override has been removed now that the build wiring below existsunified-docbuild spoke, following the same pattern used forzlan/data-connector/customer-connect:build-docs.mjs:--ziti-cni-branchflag,cloneOrUpdatecall,authUrlentry (reusesGH_ZITI_CI_REPO_ACCESS_PAT, same credential already shared byziti-doc/zlan, no new secret needed), lint targetdocusaurus.config.ts:BUILD_FLAGS.ZITICNI, remark mapping, webpack alias, static-asset exclusion, pages/docs-plugin blocks via ziti-cni's owndocusaurus-plugin-ziti-cni-docs.tsDOCUSAURUS_BUILD_MASKbumped0x3FF→0x7FFto include the new bitscripts/vercel-ignore.shto also always watchpackages/docusaurus-theme, regardless of which single path a given Vercel project is configured to check —unified-doc-previewonly watchesunified-doc/, so a theme-only change (like the picker entry itself) was being silently skipped and never showing up in previewCorresponding ziti-cni content: https://github.com/netfoundry/ziti-cni/pull/8 (draft, branch
lipscomb-cni-docs-draft)Status
Verified working end-to-end in a local build (picker entry renders, ziti-cni content builds and serves correctly at
/docs/ziti-cni/...). The one remaining blocker for the live Vercel preview specifically:unified-doc-preview's build needs read access to the privateziti-cnirepo to clone it, and since Vercel builds run outside GitHub Actions, that has to be a credential entered as a Vercel Environment Variable on that project — not a GitHub secret. Requested from the team; not yet added.Test plan
unified-doc-preview, confirm the live preview clones and renders ziti-cni's actual docs content at/docs/ziti-cni/...🤖 Generated with Claude Code