Files
zitadel/apps/docs/scripts/match-redirects.mjs
d8ea041c56 docs: introduce versioned docs and migrate to fuma (#11166)
## Todos for release

- [x] Configure Env in docs project on vercel
- [x] Configure Root Path in the docs project on vercel
- [ ] Remove old CSP https://github.com/zitadel/website/pull/1592

## What we did

This pull request migrates the project documentation from the old
`docs/` directory to the new `apps/docs/` directory, introduces a new
documentation system built with Next.js and Fumadocs, and updates all
relevant references, configuration files, and documentation to reflect
this change. It also adds new configuration and ignore files for the new
documentation app, updates CI and linting to exclude the new docs from
certain checks, and revises the contributing guidelines accordingly.

**Documentation System Migration and New Docs App**

* Migrated all documentation from `docs/` to `apps/docs/`, and updated
all references in `README.md`, `CONTRIBUTING.md`, and other files to
point to the new location.
[[1]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L585-L640)
[[2]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L660-R607)
[[3]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L740-R687)
[[4]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L2-R3)
[[5]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L30-R30)
* Added a new Next.js/Fumadocs-based documentation app under
`apps/docs/`, including core app files, layouts, routing, search API,
and a comprehensive `README.md` with development and contribution
instructions.
[[1]](diffhunk://#diff-5a1b07344a2c1b4d3f37b23ff1388b62cd9f57dea3c1cd23d8a0412b7602b132R1-R74)
[[2]](diffhunk://#diff-462b9ad1eabbb7d1c29bb9c36e4931eb180fd7190900e6d2babf8f4d66ad1c28R1-R39)
[[3]](diffhunk://#diff-e16ae25660ded787b10ac35dea96d5ecaacf895dae0afc8a9bd4382dc79a8c87R1-R7)
[apps/docs/app/[[...slug]]/layout.tsxR1-R81](diffhunk://#diff-59e08acde4e805b7aeccef1dcf98f1d71dfc550777e6b9402085cee0e9fa4e0aR1-R81),
[apps/docs/app/[[...slug]]/page.tsxR1-R79](diffhunk://#diff-e5df3f80d0fa01e12d63d81f29c57a9d14e846c78fd3beabb2ef768e38fd9580R1-R79),
[[4]](diffhunk://#diff-389b34918e040cacaa87cd7201ffa462cc2b0b716736f537e3d3c660ac69353bR1-R7)
[[5]](diffhunk://#diff-d3b03416d1c457b19f1c27b26f2db741412df841b875c26ccadc36e4522247f4R1-R29)
[[6]](diffhunk://#diff-c8fb8339570a5305809be7c618e14705fd86390dc278e6ce8ba224a7bc8b0c3cR1-R25)

**Configuration and Tooling Updates**

* Updated `.github/workflows/codeql.yml`, `.golangci.yaml`, and
`.github/dependabot.yml` to properly handle the new docs app: excluded
`apps/docs` from certain checks, added npm dependency updates for the
docs app, and excluded generated content.
[[1]](diffhunk://#diff-12783128521e452af0cfac94b99b8d250413c516ec71fe6d97dbea666ff7ba27L8-R14)
[[2]](diffhunk://#diff-9917ddc9f1c3304218f7269265b746d997c5c0615478177b5fceecd33ef47cb5R5-R6)
[[3]](diffhunk://#diff-9917ddc9f1c3304218f7269265b746d997c5c0615478177b5fceecd33ef47cb5R126-R129)
[[4]](diffhunk://#diff-dd4fbda47e51f1e35defb9275a9cd9c212ecde0b870cba89ddaaae65c5f3cd28R89-R106)
* Updated `.devcontainer/devcontainer.json` to use the latest Go 1.25.3
version for consistency.

**Licensing and Miscellaneous**

* Added `apps/docs/` to the list of licensed directories in
`LICENSING.md`.

These changes ensure the documentation is now maintained in a modern,
scalable system and all project tooling is updated to support the new
structure.

---------

Co-authored-by: Federico Coppede <fcoppede@gmail.com>
2026-01-29 08:38:36 -08:00

200 lines
6.4 KiB
JavaScript

import { glob } from 'glob';
import fs from 'fs';
import path from 'path';
import { fileURLToPath } from 'url';
const __dirname = path.dirname(fileURLToPath(import.meta.url));
const ROOT_DIR = path.join(__dirname, '..');
const OLD_XML = path.join(ROOT_DIR, 'old.xml');
const CONTENT_DIR = path.join(ROOT_DIR, 'content');
function extractUrlsFromXml(xmlContent) {
const regex = /<loc>(https:\/\/zitadel\.com\/docs\/[^<]+)<\/loc>/g;
const urls = [];
let match;
while ((match = regex.exec(xmlContent)) !== null) {
urls.push(match[1]);
}
return urls;
}
async function getNewUrlsFromContent() {
const mdxFiles = await glob('**/reference/api/**/*.mdx', { cwd: CONTENT_DIR });
const urls = mdxFiles.map(file => {
let slug = file.replace(/\.mdx$/, '');
return `https://zitadel.com/docs/${slug}`;
});
return urls;
}
function parseOldUrl(url) {
const prefix = 'https://zitadel.com/docs/apis/resources/';
if (!url.startsWith(prefix)) return null;
const rest = url.slice(prefix.length);
const [serviceDir, methodSlug] = rest.split('/');
if (!methodSlug) return { serviceDir, isIndex: true, full: url };
return { serviceDir, methodSlug, full: url };
}
function parseNewUrl(url) {
let rest;
if (url.includes('/reference/api/')) {
rest = url.split('/reference/api/')[1];
} else {
return null;
}
const parts = rest.split('/');
if (parts.length < 2) return null;
const serviceDir = parts[0];
const fileSlug = parts[1];
const methodParts = fileSlug.split('.');
const method = methodParts[methodParts.length - 1];
return { serviceDir, method, full: url, fileSlug };
}
const serviceMapping = {
'action_service_v2': 'action',
'admin': 'admin',
'mgmt': 'management',
'auth': 'auth',
'system': 'system',
'user_service_v2': 'user',
'session_service_v2': 'session',
'oidc_service_v2': 'oidc',
'settings_service_v2': 'settings',
'org_service_v2': 'org',
'org_service/v2': 'org',
'project_service_v2': 'project',
'feature_service_v2': 'feature',
'idp_service_v2': 'idp',
'instance_service_v2': 'instance',
'saml_service_v2': 'saml',
'internal_permission_service_v2': 'internal_permission',
'application_service_v2': 'application',
'authorization_service_v2': 'authorization',
'webkey_service_v2': 'webkey',
};
async function run() {
if (!fs.existsSync(OLD_XML)) {
console.error(`Old sitemap not found at ${OLD_XML}`);
process.exit(1);
}
const oldContent = fs.readFileSync(OLD_XML, 'utf8');
const oldUrls = extractUrlsFromXml(oldContent).filter(u => u.includes('/apis/resources/'));
const newUrls = (await getNewUrlsFromContent()).filter(u => !/\/v\d+\.\d+(\.\d+)?\//.test(u));
console.log(`Scanning content directory: found ${newUrls.length} unversioned new URLs.`);
const newServiceMap = {};
for (const u of newUrls) {
const parsed = parseNewUrl(u);
if (!parsed) continue;
const isVersioned = /\/v\d+\.\d+\.\d+\//.test(u);
if (!newServiceMap[parsed.serviceDir]) newServiceMap[parsed.serviceDir] = [];
if (isVersioned) {
const existing = newServiceMap[parsed.serviceDir].find(n => n.method === parsed.method && n.fileSlug === parsed.fileSlug && !/\/v\d+\.\d+\.\d+\//.test(n.full));
if (existing) continue;
}
newServiceMap[parsed.serviceDir].push(parsed);
}
const redirects = [];
const missing = [];
for (const u of oldUrls) {
const parsed = parseOldUrl(u);
if (!parsed) continue;
if (parsed.isIndex) {
const rawService = parsed.serviceDir;
const mappedService = serviceMapping[rawService] || rawService;
if (newServiceMap[mappedService]) {
redirects.push({
source: u.replace('https://zitadel.com/docs', ''),
destination: `/reference/api/${mappedService}`,
permanent: true
});
} else {
missing.push(u);
}
continue;
}
const mappedService = serviceMapping[parsed.serviceDir];
if (!mappedService || !newServiceMap[mappedService]) {
missing.push(u);
continue;
}
const candidates = newServiceMap[mappedService];
candidates.sort((a, b) => {
const aVersioned = /\/v\d+\.\d+\.\d+\//.test(a.full);
const bVersioned = /\/v\d+\.\d+\.\d+\//.test(b.full);
if (!aVersioned && bVersioned) return -1;
if (aVersioned && !bVersioned) return 1;
const lengthDiff = b.method.length - a.method.length;
if (lengthDiff !== 0) return lengthDiff;
if (a.fileSlug.includes('.v2.') && !b.fileSlug.includes('.v2.')) return -1;
if (!a.fileSlug.includes('.v2.') && b.fileSlug.includes('.v2.')) return 1;
return 0;
});
let found = null;
// Manual overrides for UserService "ghost" methods
if (mappedService === 'user') {
if (parsed.methodSlug === 'user-service-create-user') {
found = candidates.find(c => c.method === 'AddHumanUser');
} else if (parsed.methodSlug === 'user-service-update-user') {
found = candidates.find(c => c.method === 'UpdateHumanUser');
}
}
if (!found) {
for (const cand of candidates) {
const candKebab = cand.method.replace(/([a-z0-9])([A-Z])/g, '$1-$2').toLowerCase();
if (parsed.methodSlug === candKebab || parsed.methodSlug.endsWith('-' + candKebab)) {
found = cand;
break;
}
}
}
if (found) {
redirects.push({
source: u.replace('https://zitadel.com/docs', ''),
destination: found.full.replace('https://zitadel.com/docs', ''),
permanent: true
});
} else {
missing.push(u);
}
}
console.log(`Generated ${redirects.length} redirects.`);
console.log(`Missing ${missing.length} URLs.`);
fs.writeFileSync(path.join(ROOT_DIR, 'redirects.json'), JSON.stringify(redirects, null, 2));
fs.writeFileSync(path.join(ROOT_DIR, 'missing.txt'), missing.join('\n'));
}
run();