Skip to content

Upgrade to Docusaurus 3.10 #2634

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ctauchen merged 1 commit into from
Apr 13, 2026
Merged

Upgrade to Docusaurus 3.10 #2634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 45 additions & 32 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,21 @@ export default async function createAsyncConfig() {
/** @type {import('@docusaurus/types').Config} */
const config = {
future: {
experimental_faster: {
v4: {
removeLegacyPostBuildHeadAttribute: true,
useCssCascadeLayers: true,
Comment on lines 16 to +20
Copy link

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new future block is mis-indented (v4: is not aligned under future:), which breaks the file’s consistent 2-space formatting and makes the config harder to scan. Please reformat this block so keys are consistently indented.

Copilot uses AI. Check for mistakes.
siteStorageNamespacing: true,
fasterByDefault: true,
mdx1CompatDisabledByDefault: true,
},
faster: {
swcJsLoader: true,
swcJsMinimizer: true,
Comment on lines +23 to 27
Copy link

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new future block is also mis-indented for the faster: key (extra/missing leading spaces compared to surrounding keys). Please reformat so faster: aligns with v4: and other properties under future:.

Copilot uses AI. Check for mistakes.
swcHtmlMinimizer: true,
lightningCssMinimizer: true,
rspackBundler: true,
rspackPersistentCache: true,
ssgWorkerThreads: true,
mdxCrossCompilerCache: true,
},
},
Expand All @@ -35,7 +43,7 @@ export default async function createAsyncConfig() {
markdown: {
hooks: {
onBrokenMarkdownLinks: 'throw',
}
},
},

// Even if you don't use internalization, you can use this field to set useful
Expand All @@ -62,9 +70,9 @@ export default async function createAsyncConfig() {
'data-modal-header-bg-color': '#FFFFFF',
'data-user-analytics-fingerprint-enabled': 'true',
'data-user-analytics-store-ip': 'true',
'data-mcp-enabled': "true",
'data-mcp-server-url': "https://calico-docs.mcp.kapa.ai",
'data-mcp-button-text': "MCP",
'data-mcp-enabled': 'true',
'data-mcp-server-url': 'https://calico-docs.mcp.kapa.ai',
'data-mcp-button-text': 'MCP',
async: true,
},
],
Expand Down Expand Up @@ -123,10 +131,11 @@ export default async function createAsyncConfig() {
searchPagePath: '/search',
},
announcementBar: {
id: "calico_hackathon_deadline",
content: '🚀 Deadline Extended! (Ends April 30, 2026!) Finalize your GitHub repo and demo video to enter the <a href="https://www.tigera.io/lp/project-calico-hackathon?utm_source=website&utm_medium=docs_site&utm_campaign=Hackathon2026">Calico 3.30+ Hackathon.</a>',
backgroundColor: "#FCE181",
textColor: "#000",
id: 'calico_hackathon_deadline',
content:
'🚀 Deadline Extended! (Ends April 30, 2026!) Finalize your GitHub repo and demo video to enter the <a href="https://www.tigera.io/lp/project-calico-hackathon?utm_source=website&utm_medium=docs_site&utm_campaign=Hackathon2026">Calico 3.30+ Hackathon.</a>',
backgroundColor: '#FCE181',
textColor: '#000',
isCloseable: true,
},
navbar: {
Expand Down Expand Up @@ -410,15 +419,15 @@ export default async function createAsyncConfig() {
path: 'calico',
routeBasePath: 'calico',
editCurrentVersion: true,
onlyIncludeVersions: [...nextVersion, '3.31','3.30','3.29'],
onlyIncludeVersions: [...nextVersion, '3.31', '3.30', '3.29'],
lastVersion: '3.31',
versions: {
current: {
label: 'Next',
path: 'next',
banner: 'unreleased',
},
'3.31': {
3.31: {
label: '3.31 (latest)',
path: 'latest',
banner: 'none',
Expand Down Expand Up @@ -447,7 +456,7 @@ export default async function createAsyncConfig() {
path: 'calico-enterprise',
routeBasePath: 'calico-enterprise',
editCurrentVersion: true,
onlyIncludeVersions: [...nextVersion, '3.23-1','3.22-2','3.21-2','3.20-2'],
onlyIncludeVersions: [...nextVersion, '3.23-1', '3.22-2', '3.21-2', '3.20-2'],
lastVersion: '3.22-2',
versions: {
current: {
Expand Down Expand Up @@ -526,27 +535,31 @@ export default async function createAsyncConfig() {
editUrl: generateEditUrl,
},
],
['./src/plugins/docusaurus-plugin-llms-txt', {
siteDescription: 'Calico documentation for networking, network security, and observability for Kubernetes, including Calico Open Source, Calico Enterprise, and Calico Cloud.',
productDescriptions: {
'calico': 'Open source networking and network security for containers and Kubernetes.',
'calico-enterprise': 'Enterprise-grade networking, security, and observability for Kubernetes.',
'calico-cloud': 'SaaS-based Kubernetes security and observability platform.',
[
'./src/plugins/docusaurus-plugin-llms-txt',
{
siteDescription:
'Calico documentation for networking, network security, and observability for Kubernetes, including Calico Open Source, Calico Enterprise, and Calico Cloud.',
productDescriptions: {
calico: 'Open source networking and network security for containers and Kubernetes.',
'calico-enterprise': 'Enterprise-grade networking, security, and observability for Kubernetes.',
'calico-cloud': 'SaaS-based Kubernetes security and observability platform.',
},
topPages: [
'/calico/latest/getting-started/kubernetes/quickstart',
'/calico-enterprise/latest/getting-started/install-on-clusters/kubernetes/quickstart',
'/calico-cloud/get-started/connect-cluster',
'/calico/latest/networking/determine-best-networking',
'/calico/latest/network-policy/get-started/calico-policy/calico-network-policy',
'/calico-enterprise/latest/network-policy/policy-tiers/tiered-policy',
'/calico/latest/operations/ebpf/enabling-ebpf',
'/calico-enterprise/latest/observability',
'/calico/latest/networking/configuring/bgp',
'/calico-cloud/get-started/system-requirements',
],
optionalSections: ['release notes'],
},
topPages: [
'/calico/latest/getting-started/kubernetes/quickstart',
'/calico-enterprise/latest/getting-started/install-on-clusters/kubernetes/quickstart',
'/calico-cloud/get-started/connect-cluster',
'/calico/latest/networking/determine-best-networking',
'/calico/latest/network-policy/get-started/calico-policy/calico-network-policy',
'/calico-enterprise/latest/network-policy/policy-tiers/tiered-policy',
'/calico/latest/operations/ebpf/enabling-ebpf',
'/calico-enterprise/latest/observability',
'/calico/latest/networking/configuring/bgp',
'/calico-cloud/get-started/system-requirements',
],
optionalSections: ['release notes'],
}],
],
],
customFields: {
isTesting: process.env.TESTING || false,
Expand Down
18 changes: 9 additions & 9 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@
"@chakra-ui/theme-tools": "2.2.6",
"@crawlee/utils": "^3.13.10",
"@docsearch/react": "^3.9.0",
Copy link

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@docusaurus/theme-search-algolia@3.10.0 pulls in @docsearch/react@4.x, but this repo still pins @docsearch/react to ^3.9.0. That results in two major versions of DocSearch being installed (see yarn.lock entries for 3.9.0 and 4.6.2), which can increase bundle size and risks API/style mismatches for the custom SearchBar. Consider aligning the direct dependency to the 4.x range used by Docusaurus (or removing the direct dependency if it’s no longer needed) and verifying the custom src/theme/SearchBar continues to work.

Suggested change
"@docsearch/react": "^3.9.0",
"@docsearch/react": "^4.6.2",

Copilot uses AI. Check for mistakes.
"@docusaurus/core": "^3.9.2",
"@docusaurus/faster": "^3.9.2",
"@docusaurus/plugin-content-docs": "^3.9.2",
"@docusaurus/preset-classic": "^3.9.2",
"@docusaurus/theme-common": "^3.9.2",
"@docusaurus/theme-search-algolia": "^3.9.2",
"@docusaurus/core": "^3.10.0",
"@docusaurus/faster": "^3.10.0",
"@docusaurus/plugin-content-docs": "^3.10.0",
"@docusaurus/preset-classic": "^3.10.0",
"@docusaurus/theme-common": "^3.10.0",
"@docusaurus/theme-search-algolia": "^3.10.0",
"@emotion/react": "^11.9.3",
"@emotion/styled": "^11.9.3",
"@jest/globals": "^29.4.1",
Expand All @@ -67,9 +67,9 @@
"unist-util-visit": "^5.0.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.9.2",
"@docusaurus/tsconfig": "^3.9.2",
"@docusaurus/types": "^3.9.2",
"@docusaurus/module-type-aliases": "^3.10.0",
"@docusaurus/tsconfig": "^3.10.0",
"@docusaurus/types": "^3.10.0",
"@playwright/test": "1.47.2",
"@testing-library/dom": "^10.4.1",
"@testing-library/jest-dom": "^6.6.4",
Expand Down
Loading