Skip to content

Commit 44e5ed5

Browse files
dariuszkucdariuszkuc
authored
chore(docs): update website to Docuraurus V3 (#1929)
### 📝 Description Updates website to use latest [Docusaurus version](https://docusaurus.io/blog/releases/3.0) ### 🔗 Related Issues
1 parent 8ebf3c9 commit 44e5ed5

File tree

14 files changed

+5755
-3312
lines changed

14 files changed

+5755
-3312
lines changed

‎.github/workflows/http-spec-compliance.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ jobs:
2525
uses: actions/checkout@v3
2626

2727
- name: Setup Node.js
28-
uses: actions/setup-node@v3
28+
uses: actions/setup-node@v4
2929
with:
30-
node-version: 18
30+
node-version: 20
3131

3232
- name: Setup NPM cache
3333
uses: actions/cache@v3

‎.github/workflows/pr-check-docs.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ jobs:
1717
- uses: actions/checkout@v3
1818

1919
- name: Setup Node.js
20-
uses: actions/setup-node@v3
20+
uses: actions/setup-node@v4
2121
with:
22-
node-version: 18
22+
node-version: 20
2323

2424
- uses: actions/cache@v3
2525
with:

‎.github/workflows/publish-latest-docs.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ jobs:
1919
- uses: actions/checkout@v3
2020

2121
- name: Setup Node.js
22-
uses: actions/setup-node@v3
22+
uses: actions/setup-node@v4
2323
with:
24-
node-version: 18
24+
node-version: 20
2525

2626
- uses: actions/cache@v3
2727
with:

‎website/.nvmrc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
18
1+
20

‎website/docs/plugins/maven-plugin-goals.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ input for the subsequent `generate-client` goal.
3434
| Property | Type | Required | Description |
3535
| -------- | ---- | -------- | ----------- |
3636
| `endpoint` | String | yes | Target GraphQL server SDL endpoint that will be used to download schema.<br/>**User property is**: `graphql.endpoint`. |
37-
| `headers` | Map<String, Any> | | Optional HTTP headers to be specified on a SDL request.
37+
| `headers` | `Map<String, Any>` | | Optional HTTP headers to be specified on a SDL request.
3838
| `timeoutConfiguration` | TimeoutConfiguration | | Optional timeout configuration (in milliseconds) to download schema from SDL endpoint before we cancel the request.<br/>**Default values are:**<br/>connect timeout = 5000<br/>read timeout = 15000.<br/> |
3939
| `schemaFile` | File | | Target schema file.<br/>**Default value is**: `${project.build.directory}/schema.graphql`<br/>**User property is**: `graphql.schemaFile`. |
4040

@@ -241,7 +241,7 @@ instead should be used to generate input for the subsequent `generate-client` go
241241
| Property | Type | Required | Description |
242242
| -------- | ---- | -------- | ----------- |
243243
| `endpoint` | String | yes | Target GraphQL server endpoint that will be used to execute introspection queries.<br/>**User property is**: `graphql.endpoint`. |
244-
| `headers` | Map<String, Any> | | Optional HTTP headers to be specified on an introspection query. |
244+
| `headers` | `Map<String, Any>` | | Optional HTTP headers to be specified on an introspection query. |
245245
| `timeoutConfiguration` | TimeoutConfiguration | | Optional timeout configuration (in milliseconds) to download schema from SDL endpoint before we cancel the request.<br/>**Default values are:**<br/>connect timeout = 5000<br/>read timeout = 15000.<br/> |
246246
| `schemaFile` | File | | Target schema file.<br/>**Default value is**: `${project.build.directory}/schema.graphql`<br/>**User property is**: `graphql.schemaFile`. |
247247
| `streamResponse` | Boolean | | Boolean property to indicate whether to use streamed (chunked) responses.<br/>Default value is**: true. |

‎website/docusaurus.config.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ module.exports = {
4848
prism: {
4949
defaultLanguage: 'kotlin',
5050
additionalLanguages: ['kotlin', 'groovy'],
51-
theme: require('prism-react-renderer/themes/github'),
52-
darkTheme: require('prism-react-renderer/themes/dracula')
51+
theme: require('prism-react-renderer').themes.github,
52+
darkTheme: require('prism-react-renderer').themes.dracula
5353
},
5454
navbar: {
5555
title: "GraphQL Kotlin",

‎website/package-lock.json‎

Lines changed: 5569 additions & 3126 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎website/package.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
"repository": "https://github.com/ExpediaGroup/graphql-kotlin",
55
"private": true,
66
"engines": {
7-
"node": ">=18",
8-
"npm": ">=8.6"
7+
"node": ">=20",
8+
"npm": ">=9.6"
99
},
1010
"scripts": {
1111
"start": "docusaurus start",
@@ -16,8 +16,8 @@
1616
"swizzle": "docusaurus swizzle"
1717
},
1818
"dependencies": {
19-
"@docusaurus/core": "2.4.1",
20-
"@docusaurus/preset-classic": "2.4.1",
21-
"@docusaurus/theme-mermaid": "^2.4.1"
19+
"@docusaurus/core": "3.1.1",
20+
"@docusaurus/preset-classic": "3.1.1",
21+
"@docusaurus/theme-mermaid": "^3.1.1"
2222
}
2323
}

‎website/versioned_docs/version-4.x.x/plugins/maven-plugin-goals.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ input for the subsequent `generate-client` goal.
3434
| Property | Type | Required | Description |
3535
| -------- | ---- | -------- | ----------- |
3636
| `endpoint` | String | yes | Target GraphQL server SDL endpoint that will be used to download schema.<br/>**User property is**: `graphql.endpoint`. |
37-
| `headers` | Map<String, Any> | | Optional HTTP headers to be specified on a SDL request.
37+
| `headers` | `Map<String, Any>` | | Optional HTTP headers to be specified on a SDL request.
3838
| `timeoutConfiguration` | TimeoutConfiguration | | Optional timeout configuration (in milliseconds) to download schema from SDL endpoint before we cancel the request.<br/>**Default values are:**<br/>connect timeout = 5000<br/>read timeout = 15000.<br/> |
3939
| `schemaFile` | File | | Target schema file.<br/>**Default value is**: `${project.build.directory}/schema.graphql`<br/>**User property is**: `graphql.schemaFile`. |
4040

@@ -176,7 +176,7 @@ instead should be used to generate input for the subsequent `generate-client` go
176176
| Property | Type | Required | Description |
177177
| -------- | ---- | -------- | ----------- |
178178
| `endpoint` | String | yes | Target GraphQL server endpoint that will be used to execute introspection queries.<br/>**User property is**: `graphql.endpoint`. |
179-
| `headers` | Map<String, Any> | | Optional HTTP headers to be specified on an introspection query. |
179+
| `headers` | `Map<String, Any>` | | Optional HTTP headers to be specified on an introspection query. |
180180
| `timeoutConfiguration` | TimeoutConfiguration | | Optional timeout configuration (in milliseconds) to download schema from SDL endpoint before we cancel the request.<br/>**Default values are:**<br/>connect timeout = 5000<br/>read timeout = 15000.<br/> |
181181
| `schemaFile` | File | | Target schema file.<br/>**Default value is**: `${project.build.directory}/schema.graphql`<br/>**User property is**: `graphql.schemaFile`. |
182182

‎website/versioned_docs/version-5.x.x/plugins/maven-plugin-goals.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ input for the subsequent `generate-client` goal.
3434
| Property | Type | Required | Description |
3535
| -------- | ---- | -------- | ----------- |
3636
| `endpoint` | String | yes | Target GraphQL server SDL endpoint that will be used to download schema.<br/>**User property is**: `graphql.endpoint`. |
37-
| `headers` | Map<String, Any> | | Optional HTTP headers to be specified on a SDL request.
37+
| `headers` | `Map<String, Any>` | | Optional HTTP headers to be specified on a SDL request.
3838
| `timeoutConfiguration` | TimeoutConfiguration | | Optional timeout configuration (in milliseconds) to download schema from SDL endpoint before we cancel the request.<br/>**Default values are:**<br/>connect timeout = 5000<br/>read timeout = 15000.<br/> |
3939
| `schemaFile` | File | | Target schema file.<br/>**Default value is**: `${project.build.directory}/schema.graphql`<br/>**User property is**: `graphql.schemaFile`. |
4040

@@ -178,7 +178,7 @@ instead should be used to generate input for the subsequent `generate-client` go
178178
| Property | Type | Required | Description |
179179
| -------- | ---- | -------- | ----------- |
180180
| `endpoint` | String | yes | Target GraphQL server endpoint that will be used to execute introspection queries.<br/>**User property is**: `graphql.endpoint`. |
181-
| `headers` | Map<String, Any> | | Optional HTTP headers to be specified on an introspection query. |
181+
| `headers` | `Map<String, Any>` | | Optional HTTP headers to be specified on an introspection query. |
182182
| `timeoutConfiguration` | TimeoutConfiguration | | Optional timeout configuration (in milliseconds) to download schema from SDL endpoint before we cancel the request.<br/>**Default values are:**<br/>connect timeout = 5000<br/>read timeout = 15000.<br/> |
183183
| `schemaFile` | File | | Target schema file.<br/>**Default value is**: `${project.build.directory}/schema.graphql`<br/>**User property is**: `graphql.schemaFile`. |
184184

0 commit comments

Comments
 (0)