Skip to content

Commit 1b98295

Browse files
nicoalbadovholuknf
andauthored
full rename part 2 (#34)
* full rename part 2 * revert css changes unneeded * edits * add dual path * remove comments and dumproute line * new edits * final fixes maybe * updates to self-hosted/onprem * revert algolia prod crawler for the moment * remove remaining onprem vestiges * another removal of onprem --------- Co-authored-by: dovholuknf <46322585+dovholuknf@users.noreply.github.com>
1 parent ca19e8b commit 1b98295

18 files changed

Lines changed: 76 additions & 85 deletions

File tree

packages/docusaurus-theme/src/components/ProductSearch/ProductSearch.module.css

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979
.badge{padding:.16rem .55rem;border-radius:999px;font-size:.72rem;border:1px solid var(--ifm-color-emphasis-300)}
8080
.p_frontdoor{background:#e8f3ff;border-color:#c6e1ff;color:#145ea8}
8181
.p_openziti{background:#e9fff3;border-color:#c8f2df;color:#0d7a4e}
82-
.p_onprem{background:#fff3e8;border-color:#ffdcbf;color:#9a4d00}
82+
.p_selfhosted{background:#fff3e8;border-color:#ffdcbf;color:#9a4d00}
8383
.p_zlan{background:#f1edff;border-color:#d9d0ff;color:#5335b7}
8484
.p_zrok{background:#fff0f0;border-color:#ffd0d0;color:#b71c1c}
8585

@@ -173,7 +173,7 @@
173173
border-color: #c8f2df;
174174
color: #0d7a4e;
175175
}
176-
.pill.active[data-product="onprem"] {
176+
.pill.active[data-product="selfhosted"] {
177177
background: #fff3e8;
178178
border-color: #ffdcbf;
179179
color: #9a4d00;

packages/docusaurus-theme/src/components/ProductSearch/ProductSearch.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ export function ProductSearch({
146146
appId,
147147
apiKey,
148148
indexName,
149-
products = ["frontdoor", "openziti", "onprem", "zlan", "zrok"],
149+
products = ["frontdoor", "openziti", "selfhosted", "zlan", "zrok"],
150150
extraContainerClasses = [],
151151
}: ProductSearchProps) {
152152
// read initial pill from ?product= for back/forward + shareable URLs

unified-doc/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ The unified-doc site includes BackstopJS for visual regression testing against p
6060
### Overview
6161

6262
- Compares screenshots of local dev site vs production (`https://netfoundry.io/docs/`)
63-
- Tests organized by product: `openziti`, `frontdoor`, `onprem`, `zrok`, `zlan`, `home`
63+
- Tests organized by product: `openziti`, `frontdoor`, `selfhosted`, `zrok`, `zlan`, `home`
6464
- 3 viewports: desktop (1920x1080), tablet (768x1024), mobile (375x812)
6565
- Generates HTML diff reports highlighting visual differences
6666

@@ -100,7 +100,7 @@ Each product has its own set of commands:
100100
| `vrt:approve:<product>` | Approve current test screenshots as new reference |
101101
| `vrt:report:<product>` | Open HTML diff report in browser |
102102

103-
Products: `home`, `openziti`, `frontdoor`, `onprem`, `zrok`, `zlan`
103+
Products: `home`, `openziti`, `frontdoor`, `selfhosted`, `zrok`, `zlan`
104104

105105
### Workflow
106106

unified-doc/build-docs.sh

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ clone_or_update() {
8080
echo "🔑 Using BB_REPO_TOKEN_ONPREM token" >&2
8181
else
8282
url="git@bitbucket.org:netfoundry/k8s-on-prem-installations.git"
83-
echo "🔑 Using SSH for onprem" >&2
83+
echo "🔑 Using SSH for self-hosted" >&2
8484
fi
8585
;;
8686
*zrok-connector*)
@@ -154,7 +154,7 @@ lint_docs() {
154154
"${script_dir}/_remotes/zlan/docusaurus/docs"
155155
"${script_dir}/_remotes/frontdoor/docusaurus/docs"
156156
"${script_dir}/_remotes/zrok/website/docs"
157-
"${script_dir}/_remotes/onprem/docusaurus/docs"
157+
"${script_dir}/_remotes/selfhosted/docusaurus/docs"
158158
"${script_dir}/_remotes/openziti/docusaurus/docs"
159159
)
160160

@@ -284,11 +284,11 @@ if [ "${CLEAN:-0}" -eq 1 ]; then
284284
find "$script_dir/_remotes" -mindepth 1 -maxdepth 1 ! -name 'package.json' -exec rm -rf {} +
285285
fi
286286

287-
clone_or_update "https://bitbucket.org/netfoundry/zrok-connector.git" frontdoor develop
288-
clone_or_update "https://bitbucket.org/netfoundry/k8s-on-prem-installations.git" onprem main
289-
clone_or_update "https://github.com/openziti/ziti-doc.git" openziti main
290-
clone_or_update "https://github.com/netfoundry/zlan.git" zlan main
291-
clone_or_update "https://github.com/openziti/zrok.git" zrok main
287+
clone_or_update "https://bitbucket.org/netfoundry/zrok-connector.git" frontdoor develop
288+
clone_or_update "https://bitbucket.org/netfoundry/k8s-on-prem-installations.git" selfhosted full-rename
289+
clone_or_update "https://github.com/openziti/ziti-doc.git" openziti main
290+
clone_or_update "https://github.com/netfoundry/zlan.git" zlan main
291+
clone_or_update "https://github.com/openziti/zrok.git" zrok main
292292

293293
echo "========================================"
294294
echo "bd POST-CLONE DEBUG"

unified-doc/docusaurus.config.ts

Lines changed: 15 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import {zrokDocsPluginConfig} from "./_remotes/zrok/website/docusaurus-plugin-zr
1616

1717
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
1818
const frontdoor = `./_remotes/frontdoor`;
19-
const onprem = `./_remotes/onprem`;
19+
const selfhosted = `./_remotes/selfhosted`;
2020
const openziti = `./_remotes/openziti`;
2121
const zrokRoot = `./_remotes/zrok/website`;
2222
const zlan = `./_remotes/zlan`;
@@ -36,7 +36,7 @@ const BUILD_FLAGS = {
3636
NONE: 0x0,
3737
OPENZITI: 0x1,
3838
FRONTDOOR: 0x2,
39-
ONPREM: 0x4,
39+
SELFHOSTED: 0x4,
4040
ZROK: 0x8,
4141
ZLAN: 0x10,
4242
};
@@ -82,13 +82,13 @@ const prod: PublishConfig = {
8282
const cfg: PublishConfig = process.env.DOCUSAURUS_PUBLISH_ENV === 'prod' ? prod : staging;
8383

8484
const REMARK_MAPPINGS = [
85-
{ from: '@onpremdocs', to: `${docsBase}onprem` },
85+
{ from: '@selfhosteddocs', to: `${docsBase}selfhosted` },
8686
{ from: '@openzitidocs', to: `${docsBase}openziti`},
8787
{ from: '@zrokdocs', to: `${docsBase}zrok`},
8888
{ from: '@static', to: docsBase},
8989
{ from: '/openziti/', to: `${docsBase}/openziti/` },
9090
{ from: '/frontdoor/', to: `${docsBase}/frontdoor/` },
91-
{ from: '/onprem/', to: `${docsBase}/onprem/` },
91+
{ from: '/selfhosted/', to: `${docsBase}/selfhosted/` },
9292
{ from: '/zrok/', to: `${docsBase}/zrok/` },
9393
{ from: '/zlan/', to: `${docsBase}/zlan/` },
9494
];
@@ -199,7 +199,7 @@ const config: Config = {
199199
staticDirectories: [
200200
'static',
201201
'_remotes/frontdoor/docusaurus/static/',
202-
'_remotes/onprem/docusaurus/static/',
202+
'_remotes/selfhosted/docusaurus/static/',
203203
'_remotes/openziti/docusaurus/static/',
204204
'_remotes/zlan/docusaurus/static/',
205205
`${zrokRoot}/static/`,
@@ -232,7 +232,7 @@ const config: Config = {
232232
alias: {
233233
'@openziti': path.resolve(__dirname, `${openziti}/docusaurus`),
234234
'@frontdoor': path.resolve(__dirname, `${frontdoor}/docusaurus`),
235-
'@onprem': path.resolve(__dirname, `${onprem}/docusaurus`),
235+
'@selfhosted': path.resolve(__dirname, `${selfhosted}/docusaurus`),
236236
'@zlan': path.resolve(__dirname, `${zlan}/docusaurus`),
237237
'@zrok': path.resolve(__dirname, `${zrokRoot}`),
238238
'@zrokroot': path.resolve(__dirname, `${zrokRoot}`),
@@ -254,17 +254,18 @@ const config: Config = {
254254

255255
['@docusaurus/plugin-content-pages',{path: 'src/pages',routeBasePath: '/'}],
256256
build(BUILD_FLAGS.FRONTDOOR) && ['@docusaurus/plugin-content-pages',{id: `frontdoor-pages`, path: `${frontdoor}/docusaurus/src/pages`, routeBasePath: '/frontdoor'}],
257-
build(BUILD_FLAGS.ONPREM) && ['@docusaurus/plugin-content-pages',{id: `onprem-pages`, path: `${onprem}/docusaurus/src/pages`, routeBasePath: '/onprem'}],
257+
build(BUILD_FLAGS.SELFHOSTED) && ['@docusaurus/plugin-content-pages',{id: `selfhosted-pages`, path: `${selfhosted}/docusaurus/src/pages`, routeBasePath: '/selfhosted'}],
258258
build(BUILD_FLAGS.OPENZITI) && ['@docusaurus/plugin-content-pages',{id: `openziti-pages`, path: `${openziti}/docusaurus/src/pages`, routeBasePath: '/openziti'}],
259259
build(BUILD_FLAGS.ZLAN) && ['@docusaurus/plugin-content-pages',{id: `zlan-pages`, path: `${zlan}/docusaurus/src/pages`, routeBasePath: '/zlan'}],
260260
build(BUILD_FLAGS.ZROK) && ['@docusaurus/plugin-content-pages',{id: `zrok-pages`, path: `${zrokRoot}/src/pages`, routeBasePath: '/zrok'}],
261-
build(BUILD_FLAGS.ONPREM) && [
261+
build(BUILD_FLAGS.ZROK) && extendDocsPlugins(zrokDocsPluginConfig(zrokRoot, REMARK_MAPPINGS, routeBase('zrok'))),
262+
build(BUILD_FLAGS.SELFHOSTED) && [
262263
'@docusaurus/plugin-content-docs',
263264
{
264-
id: 'onprem', // do not change - affects algolia search
265-
path: `${onprem}/docusaurus/docs`,
266-
routeBasePath: routeBase('onprem'),
267-
sidebarPath: `${onprem}/docusaurus/sidebars.ts`,
265+
id: 'selfhosted',
266+
path: `${selfhosted}/docusaurus/docs`,
267+
routeBasePath: routeBase('selfhosted'),
268+
sidebarPath: `${selfhosted}/docusaurus/sidebars.ts`,
268269
includeCurrentVersion: true,
269270
beforeDefaultRemarkPlugins: [
270271
remarkGithubAdmonitionsToDirectives,
@@ -345,27 +346,14 @@ const config: Config = {
345346
blogSidebarTitle: 'All posts',
346347
},
347348
],
348-
build(BUILD_FLAGS.ZROK) && extendDocsPlugins(zrokDocsPluginConfig(zrokRoot, REMARK_MAPPINGS, routeBase('zrok'))),
349-
// Fallback redirects for JSX pages with hardcoded /docs/ paths (from upstream repos)
350-
isVercel && [
351-
'@docusaurus/plugin-client-redirects',
352-
{
353-
createRedirects(existingPath: string) {
354-
// Redirect /docs/X → /X for all doc paths
355-
return existingPath.match(/^\/(onprem|frontdoor|openziti|zrok|zlan)/)
356-
? [`/docs${existingPath}`]
357-
: undefined;
358-
},
359-
},
360-
],
361349
['@docusaurus/plugin-sitemap', { changefreq: "daily", priority: 0.8 }],
362350
[pluginHotjar, {}],
363351
['@docusaurus/plugin-google-tag-manager', {id: `openziti-gtm`, containerId: cfg.google.tag}],
364352
].filter(Boolean),
365353
themeConfig: {
366354
docs: {
367355
sidebar: {
368-
hideable: false,
356+
hideable: false,
369357
autoCollapseCategories: true
370358
}
371359
},
@@ -386,7 +374,7 @@ const config: Config = {
386374
label: 'Docs',
387375
position: 'left',
388376
items: [
389-
{ to: '/onprem/intro', label: 'On-Prem' },
377+
{ to: '/selfhosted/intro', label: 'Self-Hosted' },
390378
{ to: '/frontdoor/intro', label: 'Frontdoor' },
391379
{ to: '/openziti/learn/introduction', label: 'OpenZiti' },
392380
],

unified-doc/package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,31 +16,31 @@
1616
"vrt:generate": "node scripts/generate-vrt-scenarios.mjs all",
1717
"vrt:generate:openziti": "node scripts/generate-vrt-scenarios.mjs openziti",
1818
"vrt:generate:frontdoor": "node scripts/generate-vrt-scenarios.mjs frontdoor",
19-
"vrt:generate:onprem": "node scripts/generate-vrt-scenarios.mjs onprem",
19+
"vrt:generate:selfhosted": "node scripts/generate-vrt-scenarios.mjs selfhosted",
2020
"vrt:generate:zrok": "node scripts/generate-vrt-scenarios.mjs zrok",
2121
"vrt:generate:zlan": "node scripts/generate-vrt-scenarios.mjs zlan",
2222
"vrt:generate:home": "node scripts/generate-vrt-scenarios.mjs home",
2323
"vrt:reference:openziti": "backstop reference --config=backstop.openziti.json",
2424
"vrt:reference:frontdoor": "backstop reference --config=backstop.frontdoor.json",
25-
"vrt:reference:onprem": "backstop reference --config=backstop.onprem.json",
25+
"vrt:reference:selfhosted": "backstop reference --config=backstop.selfhosted.json",
2626
"vrt:reference:zrok": "backstop reference --config=backstop.zrok.json",
2727
"vrt:reference:zlan": "backstop reference --config=backstop.zlan.json",
2828
"vrt:reference:home": "backstop reference --config=backstop.home.json",
2929
"vrt:test:openziti": "backstop test --config=backstop.openziti.json",
3030
"vrt:test:frontdoor": "backstop test --config=backstop.frontdoor.json",
31-
"vrt:test:onprem": "backstop test --config=backstop.onprem.json",
31+
"vrt:test:selfhosted": "backstop test --config=backstop.selfhosted.json",
3232
"vrt:test:zrok": "backstop test --config=backstop.zrok.json",
3333
"vrt:test:zlan": "backstop test --config=backstop.zlan.json",
3434
"vrt:test:home": "backstop test --config=backstop.home.json",
3535
"vrt:approve:openziti": "backstop approve --config=backstop.openziti.json",
3636
"vrt:approve:frontdoor": "backstop approve --config=backstop.frontdoor.json",
37-
"vrt:approve:onprem": "backstop approve --config=backstop.onprem.json",
37+
"vrt:approve:selfhosted": "backstop approve --config=backstop.selfhosted.json",
3838
"vrt:approve:zrok": "backstop approve --config=backstop.zrok.json",
3939
"vrt:approve:zlan": "backstop approve --config=backstop.zlan.json",
4040
"vrt:approve:home": "backstop approve --config=backstop.home.json",
4141
"vrt:report:openziti": "backstop openReport --config=backstop.openziti.json",
4242
"vrt:report:frontdoor": "backstop openReport --config=backstop.frontdoor.json",
43-
"vrt:report:onprem": "backstop openReport --config=backstop.onprem.json",
43+
"vrt:report:selfhosted": "backstop openReport --config=backstop.selfhosted.json",
4444
"vrt:report:zrok": "backstop openReport --config=backstop.zrok.json",
4545
"vrt:report:zlan": "backstop openReport --config=backstop.zlan.json",
4646
"vrt:report:home": "backstop openReport --config=backstop.home.json",

unified-doc/scripts/generate-vrt-scenarios.mjs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* Usage:
66
* node scripts/generate-vrt-scenarios.mjs [product]
77
*
8-
* Products: openziti, frontdoor, onprem, zrok, zlan, home, all
8+
* Products: openziti, frontdoor, selfhosted, zrok, zlan, home, all
99
*
1010
* Examples:
1111
* node scripts/generate-vrt-scenarios.mjs openziti # Only OpenZiti pages
@@ -40,10 +40,10 @@ const PRODUCTS = {
4040
pattern: /\/frontdoor\//,
4141
include: (url) => url.includes('/frontdoor/')
4242
},
43-
onprem: {
44-
label: 'On-Prem',
45-
pattern: /\/onprem\//,
46-
include: (url) => url.includes('/onprem/')
43+
selfhosted: {
44+
label: 'Self-Hosted',
45+
pattern: /\/selfhosted\//,
46+
include: (url) => url.includes('/selfhosted/')
4747
},
4848
zrok: {
4949
label: 'zrok',
@@ -96,7 +96,7 @@ function categorizeUrls(urls) {
9696
home: [],
9797
openziti: [],
9898
frontdoor: [],
99-
onprem: [],
99+
selfhosted: [],
100100
zrok: [],
101101
zlan: [],
102102
other: []

unified-doc/scripts/vrt-run.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ const [,, action, product, flag] = process.argv;
1515

1616
if (!action || !product) {
1717
console.error('[VRT] Usage: vrt-run.mjs <reference|test|approve> <product> [--filter]');
18-
console.error('[VRT] Products: home, openziti, frontdoor, onprem, zrok, zlan');
18+
console.error('[VRT] Products: home, openziti, frontdoor, selfhosted, zrok, zlan');
1919
process.exit(1);
2020
}
2121

unified-doc/src/components/ProductSearch.module.css

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979
.badge{padding:.16rem .55rem;border-radius:999px;font-size:.72rem;border:1px solid var(--ifm-color-emphasis-300)}
8080
.p_frontdoor{background:#e8f3ff;border-color:#c6e1ff;color:#145ea8}
8181
.p_openziti{background:#e9fff3;border-color:#c8f2df;color:#0d7a4e}
82-
.p_onprem{background:#fff3e8;border-color:#ffdcbf;color:#9a4d00}
82+
.p_selfhosted{background:#fff3e8;border-color:#ffdcbf;color:#9a4d00}
8383
.p_zlan{background:#f1edff;border-color:#d9d0ff;color:#5335b7}
8484

8585
/* ===== Pagination ===== */
@@ -172,7 +172,7 @@
172172
border-color: #c8f2df;
173173
color: #0d7a4e;
174174
}
175-
.pill.active[data-product="onprem"] {
175+
.pill.active[data-product="selfhosted"] {
176176
background: #fff3e8;
177177
border-color: #ffdcbf;
178178
color: #9a4d00;

unified-doc/src/components/ProductSearch.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ export default function ProductSearch({
146146
appId,
147147
apiKey,
148148
indexName,
149-
products = ["frontdoor", "openziti", "onprem", "zlan", "zrok"],
149+
products = ["frontdoor", "openziti", "selfhosted", "zlan", "zrok"],
150150
extraContainerClasses = [],
151151
}: Props) {
152152
// read initial pill from ?product= for back/forward + shareable URLs

0 commit comments

Comments
 (0)