Skip to content

Commit ddf024c

Browse files
sserrataclaude
andauthored
Upgrade to Docusaurus 3.10 and OpenAPI docs 5.0 (PaloAltoNetworks#1187)
* Upgrade to Docusaurus 3.10, openapi-docs 5.0 - Bump all @docusaurus/* packages from 3.9.2 to 3.10.0 - Bump docusaurus-plugin-openapi-docs and docusaurus-theme-openapi-docs from 4.7.1 to 5.0.0 - Rename future.experimental_faster to future.faster (renamed in 3.10) - Fix DocCardProduct import: findFirstCategoryLink was renamed to findFirstSidebarItemLink and moved to @docusaurus/plugin-content-docs/client Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Fix HTML comment in MDX file for Docusaurus 3.10 compatibility Convert HTML comment (<!-- -->) to MDX comment ({/* */}) in terraform/docs/cloudngfw/intro.mdx. Docusaurus 3.10 with future.v4 enables stricter MDX parsing that rejects HTML comments. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Bump fast-xml-parser to ^4.5.5 to fix 5 security vulnerabilities Resolves CVEs affecting fast-xml-parser < 4.5.5: entity encoding bypass via regex injection (critical), DoS through entity expansion (high), numeric entity expansion bypass (high), entity expansion limits bypass (medium), and stack overflow in XMLBuilder (low). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent ba3d0b1 commit ddf024c

5 files changed

Lines changed: 599 additions & 548 deletions

File tree

docusaurus.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ if (process.env.CI_MERGE_REQUEST_IID) {
2121

2222
const config = {
2323
future: {
24-
experimental_faster: (process.env.DOCUSAURUS_FASTER ?? "true") === "true",
24+
faster: (process.env.DOCUSAURUS_FASTER ?? "true") === "true",
2525
v4: true
2626
},
2727
title: "Develop with Palo Alto Networks",

package.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,20 +45,20 @@
4545
},
4646
"dependencies": {
4747
"@docsearch/react": "^4.6.2",
48-
"@docusaurus/core": "3.9.2",
49-
"@docusaurus/faster": "3.9.2",
50-
"@docusaurus/plugin-client-redirects": "3.9.2",
51-
"@docusaurus/preset-classic": "3.9.2",
52-
"@docusaurus/theme-classic": "3.9.2",
53-
"@docusaurus/theme-mermaid": "3.9.2",
48+
"@docusaurus/core": "3.10.0",
49+
"@docusaurus/faster": "3.10.0",
50+
"@docusaurus/plugin-client-redirects": "3.10.0",
51+
"@docusaurus/preset-classic": "3.10.0",
52+
"@docusaurus/theme-classic": "3.10.0",
53+
"@docusaurus/theme-mermaid": "3.10.0",
5454
"@tabler/icons-react": "^3.41.1",
5555
"@tailwindcss/postcss": "^4.2.2",
5656
"algoliasearch": "^5.50.1",
5757
"clsx": "^1.2.1",
58-
"docusaurus-plugin-openapi-docs": "4.7.1",
58+
"docusaurus-plugin-openapi-docs": "5.0.0",
5959
"docusaurus-plugin-sass": "^0.2.2",
60-
"docusaurus-theme-openapi-docs": "4.7.1",
61-
"fast-xml-parser": "^4.0.10",
60+
"docusaurus-theme-openapi-docs": "5.0.0",
61+
"fast-xml-parser": "^4.5.5",
6262
"motion": "^12.38.0",
6363
"@pandev/plugin-sitemap-coveo": "./plugin-sitemap-coveo",
6464
"react": "^19.2.4",

products/terraform/docs/cloudngfw/intro.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@ Cloud NGFW can be deployed and configured with [Terraform](https://www.terraform
2323

2424
- **Cloud NGFW for Azure is leveraging the existing Azurerm provider**
2525

26-
<!---
26+
{/*
2727
This documentation is split into four sections:
2828
2929
- Getting started tutorials: Start here if you are new to Terraform for Cloud NGFW
3030
- How-to guides: Useful for achieving specific real-world objectives or solving specific real-world challenges
3131
- Background info: Higher level content discussing the "why"
3232
- Reference documentation: Lists the modules available for Cloud NGFW, with their correct usage including examples
33-
-->
33+
*/}
3434

3535
## Provider Reference
3636

src/theme/DocCardProduct/index.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ import React from "react";
88
import clsx from "clsx";
99
import Link from "@docusaurus/Link";
1010
import {
11-
findFirstCategoryLink,
11+
findFirstSidebarItemLink,
1212
useDocById,
13-
} from "@docusaurus/theme-common/internal";
13+
} from "@docusaurus/plugin-content-docs/client";
1414
import isInternalUrl from "@docusaurus/isInternalUrl";
1515
import styles from "./styles.module.css";
1616
function CardContainer({ href, children }) {
@@ -38,7 +38,7 @@ function CardLayout({ href, icon, title, description }) {
3838
);
3939
}
4040
function CardCategory({ item }) {
41-
const href = findFirstCategoryLink(item);
41+
const href = findFirstSidebarItemLink(item);
4242
return (
4343
<CardLayout
4444
href={href}

0 commit comments

Comments
 (0)