mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-03 04:42:15 +00:00
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 <[email protected]>
This commit is contained in:
Florian Forster
co-authored by
Federico Coppede
Federico Coppede
parent
7b6395c348
commit
d8ea041c56
@@ -0,0 +1,81 @@
|
||||
import { source, versionSource } from '@/lib/source';
|
||||
import { ReactNode } from 'react';
|
||||
import { DocsLayout } from 'fumadocs-ui/layouts/docs';
|
||||
import { baseOptions } from '@/lib/layout.shared';
|
||||
import { buildCustomTree } from '@/lib/custom-tree';
|
||||
import rawVersions from '@/content/versions.json';
|
||||
|
||||
const versions = rawVersions as any[];
|
||||
import { VersionSelector } from '@/components/version-selector';
|
||||
|
||||
export default async function Layout(props: { children: ReactNode; params: Promise<{ slug?: string[] }> }) {
|
||||
const params = await props.params;
|
||||
const slug = params.slug || [];
|
||||
|
||||
// Determine current version and tail path
|
||||
// If first slug segment matches a version param (e.g. v4.10), that's the version.
|
||||
// Otherwise it's latest.
|
||||
const versionParam = slug[0] && versions.find(v => v.param === slug[0]) ? slug[0] : undefined;
|
||||
const currentVersion = versionParam || 'latest';
|
||||
|
||||
const allPages = [...source.getPages(), ...versionSource.getPages()];
|
||||
const labelsMap = new Map<string, string>();
|
||||
allPages.forEach(p => {
|
||||
if (p.data.sidebar_label) {
|
||||
labelsMap.set(p.url, p.data.sidebar_label);
|
||||
}
|
||||
});
|
||||
|
||||
let tree = source.pageTree;
|
||||
if (currentVersion !== 'latest') {
|
||||
// Hoist the version folder to root to flatten sidebar
|
||||
// versionSource.pageTree -> [ v4.10 folder, v4.9 folder ... ]
|
||||
// We want the children of the specific version folder.
|
||||
|
||||
const children = (versionSource.pageTree as any).children || [];
|
||||
|
||||
const versionFolder = children.find((node: any) => {
|
||||
if (node.type !== 'folder') return false;
|
||||
// Check if the folder's index page belongs to this version
|
||||
if (node.index?.url && node.index.url.includes(`/${currentVersion}`)) return true;
|
||||
// Fallback: check first child if index missing
|
||||
if (node.children?.[0]?.url?.includes(`/${currentVersion}`)) return true;
|
||||
return false;
|
||||
});
|
||||
|
||||
if (versionFolder) {
|
||||
// Hoist children
|
||||
const hoistedTree = {
|
||||
name: versionFolder.name,
|
||||
children: versionFolder.children,
|
||||
} as any;
|
||||
|
||||
// Apply custom sidebar structure (from local sidebar-data.ts)
|
||||
// We strip the prefix '/v4.10' so the lookup matches generic keys 'guides/...'
|
||||
// The logs showed the URLs start with /[version] not /docs/[version]
|
||||
const prefix = currentVersion === 'latest' ? '/docs' : `/${currentVersion}`;
|
||||
tree = buildCustomTree(hoistedTree, {
|
||||
stripPrefix: prefix,
|
||||
labels: labelsMap
|
||||
});
|
||||
} else {
|
||||
tree = buildCustomTree(versionSource.pageTree, { labels: labelsMap });
|
||||
}
|
||||
} else {
|
||||
tree = buildCustomTree(source.pageTree, { labels: labelsMap });
|
||||
}
|
||||
|
||||
return (
|
||||
<DocsLayout
|
||||
tree={tree}
|
||||
{...baseOptions()}
|
||||
sidebar={{
|
||||
banner: (
|
||||
<VersionSelector />
|
||||
),
|
||||
}}
|
||||
>
|
||||
{props.children}
|
||||
</DocsLayout>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,79 @@
|
||||
import { getPageImage, getPage, source } from '@/lib/source';
|
||||
import {
|
||||
DocsBody,
|
||||
DocsDescription,
|
||||
DocsPage,
|
||||
DocsTitle,
|
||||
} from 'fumadocs-ui/layouts/docs/page';
|
||||
import { notFound } from 'next/navigation';
|
||||
import { getMDXComponents } from '@/mdx-components';
|
||||
import type { Metadata } from 'next';
|
||||
import { createRelativeLink } from 'fumadocs-ui/mdx';
|
||||
import { Callout } from 'fumadocs-ui/components/callout';
|
||||
import { Tab, Tabs } from 'fumadocs-ui/components/tabs';
|
||||
import { Feedback } from '@/components/feedback';
|
||||
|
||||
export default async function Page(props: any) {
|
||||
const params = await props.params;
|
||||
const { page, source: pageSource } = getPage(params.slug);
|
||||
if (!page) notFound();
|
||||
|
||||
const MDX = page.data.body;
|
||||
|
||||
return (
|
||||
<DocsPage toc={page.data.toc} full={page.data.full}>
|
||||
<DocsTitle>{page.data.title}</DocsTitle>
|
||||
<DocsDescription>{page.data.description}</DocsDescription>
|
||||
<DocsBody>
|
||||
<MDX
|
||||
components={getMDXComponents({
|
||||
Callout,
|
||||
Tab,
|
||||
Tabs,
|
||||
// this allows you to link to other pages with relative file paths
|
||||
a: createRelativeLink(pageSource, page),
|
||||
})}
|
||||
/>
|
||||
</DocsBody>
|
||||
<Feedback />
|
||||
</DocsPage>
|
||||
);
|
||||
}
|
||||
|
||||
export const dynamicParams = true;
|
||||
export const revalidate = 3600;
|
||||
|
||||
export async function generateStaticParams() {
|
||||
return source.generateParams();
|
||||
}
|
||||
|
||||
export async function generateMetadata(
|
||||
props: any,
|
||||
): Promise<Metadata> {
|
||||
const params = await props.params;
|
||||
const { page } = getPage(params.slug);
|
||||
if (!page) notFound();
|
||||
const baseUrl = 'https://zitadel.com/docs';
|
||||
const url = params.slug ? `${baseUrl}/${params.slug.join('/')}` : baseUrl;
|
||||
|
||||
let canonicalUrl = url;
|
||||
|
||||
if (params.slug?.[0]?.startsWith('v')) {
|
||||
const unversionedSlug = params.slug.slice(1);
|
||||
const unversionedPage = source.getPage(unversionedSlug);
|
||||
if (unversionedPage) {
|
||||
canonicalUrl = `${baseUrl}${unversionedPage.url === '/' ? '' : unversionedPage.url}`;
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
title: page.data.title,
|
||||
description: page.data.description,
|
||||
alternates: {
|
||||
canonical: canonicalUrl,
|
||||
},
|
||||
openGraph: {
|
||||
images: getPageImage(page).url,
|
||||
},
|
||||
};
|
||||
}
|
||||
Reference in New Issue
Block a user