Skip to content

Commit

Permalink
chore(deps): migrate docusaurus to v3 (Farfetch#512)
Browse files Browse the repository at this point in the history
  • Loading branch information
Gui Ferreira authored Jan 22, 2024
1 parent b89b7e4 commit 1c7508d
Show file tree
Hide file tree
Showing 11 changed files with 3,607 additions and 2,409 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy-website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
with:
dotnet-version: '6.0.x'

- run: dotnet tool install --global gsferreira.XmlDocMarkdown.Docusaurus --version 0.0.1-beta1 # using this version while the Pull Request isn't accepted here: https://github.com/ejball/XmlDocMarkdown/pull/126
- run: dotnet tool install --global gsferreira.XmlDocMarkdown.Docusaurus --version 0.0.1-beta2 # using this version while the Pull Request isn't accepted here: https://github.com/ejball/XmlDocMarkdown/pull/126
shell: bash

- name: .NET Publish
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-deploy-website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
with:
dotnet-version: '6.0.x'

- run: dotnet tool install --global gsferreira.XmlDocMarkdown.Docusaurus --version 0.0.1-beta1 # using this version while the Pull Request isn't accepted here: https://github.com/ejball/XmlDocMarkdown/pull/126
- run: dotnet tool install --global gsferreira.XmlDocMarkdown.Docusaurus --version 0.0.1-beta2 # using this version while the Pull Request isn't accepted here: https://github.com/ejball/XmlDocMarkdown/pull/126
shell: bash

- name: .NET Publish
Expand Down
2 changes: 1 addition & 1 deletion website/docs/guides/admin/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ KafkaFlow provides a Dashboard where you can visualize information related to yo

:::caution
It is important to note that the Dashboard runs, shows information, and manages the consumers on all application instances. This means that if you have 10 machines running your application, the Dashboard will run in every instance. **Any operation will affect the consumer in all the machines**.
:::caution
:::

## Adding the Dashboard

Expand Down
13 changes: 7 additions & 6 deletions website/docs/guides/global-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,13 @@ sidebar_position: 9
In this section, we will delve into the concept of Global Events in KafkaFlow, which provides a mechanism to subscribe to various events that are triggered during the message production and consumption processes.

KafkaFlow offers a range of Global Events that can be subscribed to. These events can be used to monitor and react to different stages of message handling. Below is a list of available events:
- [Message Produce Started Event](#message-produce-started-event)
- [Message Produce Completed Event](#message-produce-completed-event)
- [Message Produce Error Event](#message-produce-error-event)
- [Message Consume Started Event](#message-consume-started-event)
- [Message Consume Completed Event](#message-consume-completed-event)
- [Message Consume Error Event](#message-consume-error-event)

- [Message Produce Started Event](#message-produce-started-event)
- [Message Produce Completed Event](#message-produce-completed-event)
- [Message Produce Error Event](#message-produce-error-event)
- [Message Consume Started Event](#message-consume-started-event)
- [Message Consume Completed Event](#message-consume-completed-event)
- [Message Consume Error Event](#message-consume-error-event)

## Message Produce Started Event {#message-produce-started-event}

Expand Down
2 changes: 1 addition & 1 deletion website/docs/guides/middlewares/serializer-middleware.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Both classes can be provided as an argument through a factory method too.

:::tip
For topics that have just one message type, use the `AddSingleTypeSerializer`/`AddSingleTypeDeserializer` method.
:::tip
:::


```csharp
Expand Down
7 changes: 4 additions & 3 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
const {themes} = require('prism-react-renderer');
const lightCodeTheme = themes.github;
const darkCodeTheme = themes.dracula;

/** @type {import('@docusaurus/types').Config} */
const config = {
Expand Down Expand Up @@ -146,7 +147,7 @@ const config = {
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
additionalLanguages: ['csharp']
additionalLanguages: ['csharp', 'bash', 'json']
},
}),
};
Expand Down
18 changes: 9 additions & 9 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
"@docusaurus/core": "^2.4.0",
"@docusaurus/preset-classic": "^2.4.0",
"@mdx-js/react": "^1.6.22",
"@docusaurus/core": "^3.1.0",
"@docusaurus/preset-classic": "^3.1.0",
"@mdx-js/react": "^3.0.0",
"clsx": "^1.2.1",
"prism-react-renderer": "^1.3.5",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"react-lite-youtube-embed": "^2.3.52"
"prism-react-renderer": "^2.3.1",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-lite-youtube-embed": "^2.4.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^2.2.0"
"@docusaurus/module-type-aliases": "^3.1.0"
},
"browserslist": {
"production": [
Expand All @@ -39,6 +39,6 @@
]
},
"engines": {
"node": ">=16.14"
"node": ">=18.0"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ KafkaFlow provides a Dashboard where you can visualize information related to yo

:::caution
It is important to note that the Dashboard runs, shows information, and manages the consumers on all application instances. This means that if you have 10 machines running your application, the Dashboard will run in every instance. **Any operation will affect the consumer in all the machines**.
:::caution
:::

## Adding the Dashboard

Expand Down
15 changes: 8 additions & 7 deletions website/versioned_docs/version-2.x/guides/global-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,13 @@ sidebar_position: 9
In this section, we will delve into the concept of Global Events in KafkaFlow, which provides a mechanism to subscribe to various events that are triggered during the message production and consumption processes.

KafkaFlow offers a range of Global Events that can be subscribed to. These events can be used to monitor and react to different stages of message handling. Below is a list of available events:
- [Message Produce Started Event](#message-produce-started-event)
- [Message Produce Completed Event](#message-produce-completed-event)
- [Message Produce Error Event](#message-produce-error-event)
- [Message Consume Started Event](#message-consume-started-event)
- [Message Consume Completed Event](#message-consume-completed-event)
- [Message Consume Error Event](#message-consume-error-event)

- [Message Produce Started Event](#message-produce-started-event)
- [Message Produce Completed Event](#message-produce-completed-event)
- [Message Produce Error Event](#message-produce-error-event)
- [Message Consume Started Event](#message-consume-started-event)
- [Message Consume Completed Event](#message-consume-completed-event)
- [Message Consume Error Event](#message-consume-error-event)

## Message Produce Started Event {#message-produce-started-event}

Expand Down Expand Up @@ -84,7 +85,7 @@ The Message Consume Completed Event signals the successful completion of message

:::info
Please note that the current event is not compatible with Batch Consume in the current version (v2). However, this limitation is expected to be addressed in future releases (v3+).
:::info
:::

```csharp
services.AddKafka(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Both classes can be provided as an argument through a factory method too.

:::tip
For topics that have just one message type, use the `AddSingleTypeSerializer` method.
:::tip
:::


```csharp
Expand Down
Loading

0 comments on commit 1c7508d

Please sign in to comment.