From a39a448d7d88bb7eb3a5c7e6f5f731eb792dcbf5 Mon Sep 17 00:00:00 2001 From: dovholuknf <46322585+dovholuknf@users.noreply.github.com> Date: Fri, 30 Jan 2026 15:35:33 -0500 Subject: [PATCH 1/3] updates to use docs plugins defined in a file --- unified-doc/build-docs.sh | 2 +- unified-doc/docusaurus.config.ts | 124 +++++++++---------------------- unified-doc/yarn.lock | 17 ++++- 3 files changed, 52 insertions(+), 91 deletions(-) diff --git a/unified-doc/build-docs.sh b/unified-doc/build-docs.sh index aba0707..ac76012 100755 --- a/unified-doc/build-docs.sh +++ b/unified-doc/build-docs.sh @@ -288,7 +288,7 @@ clone_or_update "https://bitbucket.org/netfoundry/zrok-connector.git" clone_or_update "https://bitbucket.org/netfoundry/k8s-on-prem-installations.git" onprem main clone_or_update "https://github.com/openziti/ziti-doc.git" openziti main clone_or_update "https://github.com/netfoundry/zlan.git" zlan main -clone_or_update "https://github.com/openziti/zrok.git" zrok update-to-theme +clone_or_update "https://github.com/openziti/zrok.git" zrok update-to-theme-with-versioning echo "========================================" echo "bd POST-CLONE DEBUG" diff --git a/unified-doc/docusaurus.config.ts b/unified-doc/docusaurus.config.ts index 39d541c..81ca8a7 100644 --- a/unified-doc/docusaurus.config.ts +++ b/unified-doc/docusaurus.config.ts @@ -13,17 +13,28 @@ import remarkGithubAdmonitionsToDirectives from "remark-github-admonitions-to-di import {pluginHotjar} from "@netfoundry/docusaurus-theme/node"; import {PublishConfig} from 'src/components/docusaurus' import {zrokDocsPluginConfig} from "./_remotes/zrok/website/docusaurus-plugin-zrok-docs.ts"; +import {frontdoorDocsPluginConfig} from "./_remotes/frontdoor/docusaurus/docusaurus-plugin-frontdoor-docs.ts"; +import {onpremDocsPluginConfig} from "./_remotes/onprem/docusaurus/docusaurus-plugin-onprem-docs.ts"; +import {openzitiDocsPluginConfig} from "./_remotes/openziti/docusaurus/docusaurus-plugin-openziti-docs.ts"; +import {zlanDocsPluginConfig} from "./_remotes/zlan/docusaurus/docusaurus-plugin-zlan-docs.ts"; // This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) -const frontdoor = `./_remotes/frontdoor`; -const onprem = `./_remotes/onprem`; -const openziti = `./_remotes/openziti`; +const frontdoorRoot = `./_remotes/frontdoor/docusaurus`; +const onpremRoot = `./_remotes/onprem/docusaurus`; +const openzitiRoot = `./_remotes/openziti/docusaurus`; const zrokRoot = `./_remotes/zrok/website`; -const zlan = `./_remotes/zlan`; +const zlanRoot = `./_remotes/zlan/docusaurus`; const isVercel = process.env.IS_VERCEL === 'true'; const docsBase = isVercel ? '/' : '/docs/'; +// For unified-doc (baseUrl '/docs/'), use just the name. For standalone (baseUrl '/'), use 'docs/{name}'. +const frontdoorRouteBase = isVercel ? 'docs/frontdoor' : 'frontdoor'; +const onpremRouteBase = isVercel ? 'docs/onprem' : 'onprem'; +const openzitiRouteBase = isVercel ? 'docs/openziti' : 'openziti'; +const zrokRouteBase = isVercel ? 'docs/zrok' : 'zrok'; +const zlanRouteBase = isVercel ? 'docs/zlan' : 'zlan'; + const buildMask = parseInt(process.env.DOCUSAURUS_BUILD_MASK ?? "0xFF", 16); const BUILD_FLAGS = { @@ -78,7 +89,7 @@ const cfg: PublishConfig = process.env.DOCUSAURUS_PUBLISH_ENV === 'prod' ? prod const REMARK_MAPPINGS = [ { from: '@onpremdocs', to: `${docsBase}onprem` }, { from: '@openzitidocs', to: `${docsBase}openziti`}, - { from: '@zrokdocs', to: `${docsBase}zrok`}, + { from: '@zrokdocs', to: `/docs/zrok`}, { from: '@static', to: docsBase}, ]; @@ -187,10 +198,10 @@ const config: Config = { }, staticDirectories: [ 'static', - '_remotes/frontdoor/docusaurus/static/', - '_remotes/onprem/docusaurus/static/', - '_remotes/openziti/docusaurus/static/', - '_remotes/zlan/docusaurus/static/', + `${frontdoorRoot}/static/`, + `${onpremRoot}/static/`, + `${openzitiRoot}/static/`, + `${zlanRoot}/static/`, `${zrokRoot}/static/`, `${zrokRoot}/docs/images` ], @@ -219,10 +230,10 @@ const config: Config = { return { resolve: { alias: { - '@openziti': path.resolve(__dirname, `${openziti}/docusaurus`), - '@frontdoor': path.resolve(__dirname, `${frontdoor}/docusaurus`), - '@onprem': path.resolve(__dirname, `${onprem}/docusaurus`), - '@zlan': path.resolve(__dirname, `${zlan}/docusaurus`), + '@openziti': path.resolve(__dirname, openzitiRoot), + '@frontdoor': path.resolve(__dirname, frontdoorRoot), + '@onprem': path.resolve(__dirname, onpremRoot), + '@zlan': path.resolve(__dirname, zlanRoot), '@zrok': path.resolve(__dirname, `${zrokRoot}`), '@zrokroot': path.resolve(__dirname, `${zrokRoot}`), '@staticdir': path.resolve(__dirname, `docusaurus/static`), @@ -242,80 +253,15 @@ const config: Config = { }, ['@docusaurus/plugin-content-pages',{path: 'src/pages',routeBasePath: '/'}], - build(BUILD_FLAGS.FRONTDOOR) && ['@docusaurus/plugin-content-pages',{id: `frontdoor-pages`, path: `${frontdoor}/docusaurus/src/pages`, routeBasePath: '/frontdoor'}], - build(BUILD_FLAGS.ONPREM) && ['@docusaurus/plugin-content-pages',{id: `onprem-pages`, path: `${onprem}/docusaurus/src/pages`, routeBasePath: '/onprem'}], - build(BUILD_FLAGS.OPENZITI) && ['@docusaurus/plugin-content-pages',{id: `openziti-pages`, path: `${openziti}/docusaurus/src/pages`, routeBasePath: '/openziti'}], - build(BUILD_FLAGS.ZLAN) && ['@docusaurus/plugin-content-pages',{id: `zlan-pages`, path: `${zlan}/docusaurus/src/pages`, routeBasePath: '/zlan'}], + build(BUILD_FLAGS.FRONTDOOR) && ['@docusaurus/plugin-content-pages',{id: `frontdoor-pages`, path: `${frontdoorRoot}/src/pages`, routeBasePath: '/frontdoor'}], + build(BUILD_FLAGS.ONPREM) && ['@docusaurus/plugin-content-pages',{id: `onprem-pages`, path: `${onpremRoot}/src/pages`, routeBasePath: '/onprem'}], + build(BUILD_FLAGS.OPENZITI) && ['@docusaurus/plugin-content-pages',{id: `openziti-pages`, path: `${openzitiRoot}/src/pages`, routeBasePath: '/openziti'}], + build(BUILD_FLAGS.ZLAN) && ['@docusaurus/plugin-content-pages',{id: `zlan-pages`, path: `${zlanRoot}/src/pages`, routeBasePath: '/zlan'}], build(BUILD_FLAGS.ZROK) && ['@docusaurus/plugin-content-pages',{id: `zrok-pages`, path: `${zrokRoot}/src/pages`, routeBasePath: '/zrok'}], - build(BUILD_FLAGS.ONPREM) && [ - '@docusaurus/plugin-content-docs', - { - id: 'onprem', // do not change - affects algolia search - path: `${onprem}/docusaurus/docs`, - routeBasePath: 'onprem', - sidebarPath: `${onprem}/docusaurus/sidebars.ts`, - includeCurrentVersion: true, - beforeDefaultRemarkPlugins: [ - remarkGithubAdmonitionsToDirectives, - ], - remarkPlugins: [ - [remarkScopedPath, { mappings: REMARK_MAPPINGS, debug: false }], - [remarkCodeSections, { logLevel: LogLevel.Silent }], - ], - }, - ], - build(BUILD_FLAGS.FRONTDOOR) && [ - '@docusaurus/plugin-content-docs', - { - id: 'frontdoor', // do not change - affects algolia search - path: `${frontdoor}/docusaurus/docs`, - routeBasePath: 'frontdoor', - sidebarPath: `${frontdoor}/docusaurus/sidebars.ts`, - includeCurrentVersion: true, - beforeDefaultRemarkPlugins: [ - remarkGithubAdmonitionsToDirectives, - ], - remarkPlugins: [ - [remarkScopedPath, { mappings: REMARK_MAPPINGS, logLevel: LogLevel.Silent}], - [remarkCodeSections, { logLevel: LogLevel.Silent }], - ], - }, - ], - build(BUILD_FLAGS.OPENZITI) && [ - '@docusaurus/plugin-content-docs', - { - id: 'openziti', // do not change - affects algolia search - path: `${openziti}/docusaurus/docs`, - routeBasePath: 'openziti', - sidebarPath: `${openziti}/docusaurus/sidebars.ts`, - includeCurrentVersion: true, - beforeDefaultRemarkPlugins: [ - remarkGithubAdmonitionsToDirectives, - ], - remarkPlugins: [ - [remarkReplaceMetaUrl, {from: '@staticoz', to: `${docsBase}openziti`, logLevel: LogLevel.Silent}], - [remarkScopedPath, { mappings: REMARK_MAPPINGS, logLevel: LogLevel.Silent }], - [remarkCodeSections, { logLevel: LogLevel.Debug }], - ], - }, - ], - build(BUILD_FLAGS.ZLAN) && [ - '@docusaurus/plugin-content-docs', - { - id: 'zlan', // do not change - affects algolia search - path: `${zlan}/docusaurus/docs`, - routeBasePath: 'zlan', - sidebarPath: `${zlan}/docusaurus/sidebars.ts`, - includeCurrentVersion: true, - beforeDefaultRemarkPlugins: [ - remarkGithubAdmonitionsToDirectives, - ], - remarkPlugins: [ - [remarkScopedPath, { mappings: REMARK_MAPPINGS, logLevel: LogLevel.Silent }], - [remarkCodeSections, { logLevel: LogLevel.Silent }], - ], - }, - ], + build(BUILD_FLAGS.ONPREM) && extendDocsPlugins(onpremDocsPluginConfig(onpremRoot, REMARK_MAPPINGS, onpremRouteBase)), + build(BUILD_FLAGS.FRONTDOOR) && extendDocsPlugins(frontdoorDocsPluginConfig(frontdoorRoot, REMARK_MAPPINGS, frontdoorRouteBase)), + build(BUILD_FLAGS.OPENZITI) && extendDocsPlugins(openzitiDocsPluginConfig(openzitiRoot, REMARK_MAPPINGS, openzitiRouteBase, `${docsBase}openziti`)), + build(BUILD_FLAGS.ZLAN) && extendDocsPlugins(zlanDocsPluginConfig(zlanRoot, REMARK_MAPPINGS, zlanRouteBase)), build(BUILD_FLAGS.OPENZITI) && [ '@docusaurus/plugin-content-blog', { @@ -323,7 +269,7 @@ const config: Config = { routeBasePath: 'openziti/blog', tagsBasePath: 'tags', include: ['**/*.{md,mdx}'], - path: '_remotes/openziti/docusaurus/blog', + path: `${openzitiRoot}/blog`, remarkPlugins: [ remarkYouTube, [remarkReplaceMetaUrl, {from: '@staticoz', to: `${docsBase}openziti`, logLevel: LogLevel.Silent}], @@ -334,7 +280,7 @@ const config: Config = { blogSidebarTitle: 'All posts', }, ], - build(BUILD_FLAGS.ZROK) && extendDocsPlugins(zrokDocsPluginConfig(zrokRoot, REMARK_MAPPINGS)), + build(BUILD_FLAGS.ZROK) && extendDocsPlugins(zrokDocsPluginConfig(zrokRoot, REMARK_MAPPINGS, zrokRouteBase)), // Fallback redirects for JSX pages with hardcoded /docs/ paths (from upstream repos) isVercel && [ '@docusaurus/plugin-client-redirects', @@ -410,7 +356,7 @@ const config: Config = { specs: [ { id: 'openapi', - spec: `${frontdoor}/docusaurus/static/frontdoor-api-spec.yaml`, + spec: `${frontdoorRoot}/static/frontdoor-api-spec.yaml`, }, { id: 'edge-client', diff --git a/unified-doc/yarn.lock b/unified-doc/yarn.lock index 38cb0d9..6c514c2 100644 --- a/unified-doc/yarn.lock +++ b/unified-doc/yarn.lock @@ -2688,6 +2688,21 @@ require-from-string "^2.0.2" uri-js-replace "^1.0.1" +"@redocly/ajv@^8.11.2": + version "8.17.2" + resolved "https://registry.yarnpkg.com/@redocly/ajv/-/ajv-8.17.2.tgz#17abe1f8b6d17c1d4185be5359bac394b13bec4d" + integrity sha512-rcbDZOfXAgGEJeJ30aWCVVJvxV9ooevb/m1/SFblO2qHs4cqTk178gx7T/vdslf57EA4lTofrwsq5K8rxK9g+g== + dependencies: + fast-deep-equal "^3.1.3" + fast-uri "^3.0.1" + json-schema-traverse "^1.0.0" + require-from-string "^2.0.2" + +"@redocly/config@^0.22.0": + version "0.22.2" + resolved "https://registry.yarnpkg.com/@redocly/config/-/config-0.22.2.tgz#9a05e694816d53a5236cf8768d3cad0e49d8b116" + integrity sha512-roRDai8/zr2S9YfmzUfNhKjOF0NdcOIqF7bhf4MVC5UxpjIysDjyudvlAiVbpPHp3eDRWbdzUgtkK1a7YiDNyQ== + "@redocly/config@^0.6.0": version "0.6.3" resolved "https://registry.yarnpkg.com/@redocly/config/-/config-0.6.3.tgz#0dab6278721abd5aae6b375deee97665005b0472" @@ -6906,7 +6921,7 @@ http2-wrapper@^2.1.10: quick-lru "^5.1.1" resolve-alpn "^1.2.0" -https-proxy-agent@^7.0.4, https-proxy-agent@^7.0.6: +https-proxy-agent@^7.0.4, https-proxy-agent@^7.0.5, https-proxy-agent@^7.0.6: version "7.0.6" resolved "https://registry.yarnpkg.com/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz#da8dfeac7da130b05c2ba4b59c9b6cd66611a6b9" integrity sha512-vK9P5/iUfdl95AI+JVyUuIcVtd4ofvtrOr3HNtM2yxC9bnMbEdp3x01OhQNnjb8IJYi38VlTE3mBXwcfvywuSw== From 176d537972698eef02e5978edd27d33859421346 Mon Sep 17 00:00:00 2001 From: dovholuknf <46322585+dovholuknf@users.noreply.github.com> Date: Fri, 30 Jan 2026 15:51:16 -0500 Subject: [PATCH 2/3] update branches --- unified-doc/build-docs.sh | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/unified-doc/build-docs.sh b/unified-doc/build-docs.sh index ac76012..0c08824 100755 --- a/unified-doc/build-docs.sh +++ b/unified-doc/build-docs.sh @@ -284,10 +284,10 @@ if [ "${CLEAN:-0}" -eq 1 ]; then rm -rf "$script_dir/_remotes" fi -clone_or_update "https://bitbucket.org/netfoundry/zrok-connector.git" frontdoor develop -clone_or_update "https://bitbucket.org/netfoundry/k8s-on-prem-installations.git" onprem main -clone_or_update "https://github.com/openziti/ziti-doc.git" openziti main -clone_or_update "https://github.com/netfoundry/zlan.git" zlan main +clone_or_update "https://bitbucket.org/netfoundry/zrok-connector.git" frontdoor reusable-doc-plugin +clone_or_update "https://bitbucket.org/netfoundry/k8s-on-prem-installations.git" onprem reusable-doc-plugin +clone_or_update "https://github.com/openziti/ziti-doc.git" openziti reusable-doc-plugin +clone_or_update "https://github.com/netfoundry/zlan.git" zlan reusable-doc-plugin clone_or_update "https://github.com/openziti/zrok.git" zrok update-to-theme-with-versioning echo "========================================" From 55cd8c60bfd0d3b70b264a6de7e4311b0d921d80 Mon Sep 17 00:00:00 2001 From: dovholuknf <46322585+dovholuknf@users.noreply.github.com> Date: Fri, 30 Jan 2026 18:27:04 -0500 Subject: [PATCH 3/3] updating to new doc layouts --- unified-doc/build-docs.sh | 2 +- unified-doc/docusaurus.config.ts | 14 +++++----- unified-doc/src/pages/docs/index.tsx | 36 +++++++++++++------------- unified-doc/src/pages/index.tsx | 38 ++++++++++++++-------------- 4 files changed, 45 insertions(+), 45 deletions(-) diff --git a/unified-doc/build-docs.sh b/unified-doc/build-docs.sh index 0c08824..3fe2e5a 100755 --- a/unified-doc/build-docs.sh +++ b/unified-doc/build-docs.sh @@ -343,5 +343,5 @@ echo "========================================" now=$(date) echo "$now" > "${script_dir}/static/build-time.txt" echo "BUILDING docs into: build${BUILD_QUALIFIER} at $now" -yarn build --out-dir "build${BUILD_QUALIFIER}" 2>&1 +yarn build --no-minify --out-dir "build${BUILD_QUALIFIER}" 2>&1 popd >/dev/null diff --git a/unified-doc/docusaurus.config.ts b/unified-doc/docusaurus.config.ts index 81ca8a7..4d93183 100644 --- a/unified-doc/docusaurus.config.ts +++ b/unified-doc/docusaurus.config.ts @@ -87,10 +87,10 @@ const prod: PublishConfig = { const cfg: PublishConfig = process.env.DOCUSAURUS_PUBLISH_ENV === 'prod' ? prod : staging; const REMARK_MAPPINGS = [ - { from: '@onpremdocs', to: `${docsBase}onprem` }, - { from: '@openzitidocs', to: `${docsBase}openziti`}, + { from: '@onpremdocs', to: `/docs/onprem` }, + { from: '@openzitidocs', to: `/docs/openziti`}, { from: '@zrokdocs', to: `/docs/zrok`}, - { from: '@static', to: docsBase}, + { from: '@static', to: `/docs/`}, ]; console.log("CANONICAL URL : " + cfg.docusaurus.url); @@ -260,7 +260,7 @@ const config: Config = { build(BUILD_FLAGS.ZROK) && ['@docusaurus/plugin-content-pages',{id: `zrok-pages`, path: `${zrokRoot}/src/pages`, routeBasePath: '/zrok'}], build(BUILD_FLAGS.ONPREM) && extendDocsPlugins(onpremDocsPluginConfig(onpremRoot, REMARK_MAPPINGS, onpremRouteBase)), build(BUILD_FLAGS.FRONTDOOR) && extendDocsPlugins(frontdoorDocsPluginConfig(frontdoorRoot, REMARK_MAPPINGS, frontdoorRouteBase)), - build(BUILD_FLAGS.OPENZITI) && extendDocsPlugins(openzitiDocsPluginConfig(openzitiRoot, REMARK_MAPPINGS, openzitiRouteBase, `${docsBase}openziti`)), + build(BUILD_FLAGS.OPENZITI) && extendDocsPlugins(openzitiDocsPluginConfig(openzitiRoot, REMARK_MAPPINGS, openzitiRouteBase, `/docs/openziti`)), build(BUILD_FLAGS.ZLAN) && extendDocsPlugins(zlanDocsPluginConfig(zlanRoot, REMARK_MAPPINGS, zlanRouteBase)), build(BUILD_FLAGS.OPENZITI) && [ '@docusaurus/plugin-content-blog', @@ -321,9 +321,9 @@ const config: Config = { label: 'Docs', position: 'left', items: [ - { to: '/onprem/intro', label: 'On-Prem' }, - { to: '/frontdoor/intro', label: 'Frontdoor' }, - { to: '/openziti/learn/introduction', label: 'OpenZiti' }, + { to: '/docs/onprem/intro', label: 'On-Prem' }, + { to: '/docs/frontdoor/intro', label: 'Frontdoor' }, + { to: '/docs/openziti/learn/introduction', label: 'OpenZiti' }, ], }, ], diff --git a/unified-doc/src/pages/docs/index.tsx b/unified-doc/src/pages/docs/index.tsx index 7391c06..ccd89a7 100644 --- a/unified-doc/src/pages/docs/index.tsx +++ b/unified-doc/src/pages/docs/index.tsx @@ -31,13 +31,13 @@ export default function Home(): ReactNode {
NetFoundry SaaS Docs - On-Prem Docs + On-Prem Docs - Frontdoor Docs + Frontdoor Docs - OpenZiti Docs + OpenZiti Docs - zLAN Docs + zLAN Docs
@@ -63,7 +63,7 @@ export default function Home(): ReactNode { Enterprise self-hosted platform for OpenZiti overlays.
- Go to NetFoundry On-Prem + Go to NetFoundry On-Prem
@@ -74,7 +74,7 @@ export default function Home(): ReactNode { Zero-trust inbound access to private apps and services.
- Go to NetFoundry Frontdoor + Go to NetFoundry Frontdoor
@@ -85,7 +85,7 @@ export default function Home(): ReactNode { Open-source zero-trust networking project and SDKs.
- Go to OpenZiti + Go to OpenZiti
@@ -96,7 +96,7 @@ export default function Home(): ReactNode { Built on the robust foundation of NetFoundy OpenZiti, NetFoundry zLAN combines advanced firewall capabilities with the power of zero trust and secure network overlay
- Go to zLAN + Go to zLAN
@@ -108,11 +108,11 @@ export default function Home(): ReactNode {

Quick Links

@@ -122,11 +122,11 @@ export default function Home(): ReactNode {

Support

diff --git a/unified-doc/src/pages/index.tsx b/unified-doc/src/pages/index.tsx index 3f196cd..c664bc8 100644 --- a/unified-doc/src/pages/index.tsx +++ b/unified-doc/src/pages/index.tsx @@ -31,13 +31,13 @@ export default function Home(): ReactNode {
NetFoundry SaaS Docs - On-Prem Docs + On-Prem Docs - Frontdoor Docs + Frontdoor Docs - OpenZiti Docs + OpenZiti Docs - zLAN Docs + zLAN Docs
@@ -63,7 +63,7 @@ export default function Home(): ReactNode { Enterprise self-hosted platform for OpenZiti overlays.
- Go to NetFoundry On-Prem + Go to NetFoundry On-Prem
@@ -74,7 +74,7 @@ export default function Home(): ReactNode { Zero-trust inbound access to private apps and services.
- Go to NetFoundry Frontdoor + Go to NetFoundry Frontdoor
@@ -85,7 +85,7 @@ export default function Home(): ReactNode { Open-source zero-trust networking project and SDKs.
- Go to OpenZiti + Go to OpenZiti
@@ -96,7 +96,7 @@ export default function Home(): ReactNode { Built on the robust foundation of NetFoundy OpenZiti, NetFoundry zLAN combines advanced firewall capabilities with the power of zero trust and secure network overlay
- Go to zLAN + Go to zLAN
@@ -107,7 +107,7 @@ export default function Home(): ReactNode { zrok is an open-source, self-hostable sharing platform that simplifies shielding and sharing network services or files.
- Go to zrok + Go to zrok
@@ -119,11 +119,11 @@ export default function Home(): ReactNode {

Quick Links

@@ -133,11 +133,11 @@ export default function Home(): ReactNode {

Support