Skip to content

Commit

Permalink
docs: Add redirect for discord and maillist (#4312)
Browse files Browse the repository at this point in the history
Add redirect for discord and maillist

Signed-off-by: Xuanwo <[email protected]>
  • Loading branch information
Xuanwo authored Mar 4, 2024
1 parent a510291 commit 7f46293
Show file tree
Hide file tree
Showing 6 changed files with 1,787 additions and 1,361 deletions.
2 changes: 2 additions & 0 deletions .typos.toml
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,6 @@ extend-exclude = [
# Generated SSH Keys.
"fixtures/sftp/test_ssh_key",
"fixtures/sftp/test_ssh_key.pub",
# Generated pnpm locks.
"website/pnpm-lock.yaml"
]
2 changes: 1 addition & 1 deletion core/src/services/swift/compatible_services.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### OpenStack Swift

[OpenStack Swift](https://docs.openstack.org/swift/latest/) is the default implementations of swift servcies.
[OpenStack Swift](https://docs.openstack.org/swift/latest/) is the default implementations of swift services.

To connect to OpenStack Swift, we need to set:

Expand Down
11 changes: 6 additions & 5 deletions website/DEPENDENCIES.node.csv
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
"module name","license","repository"
"@docusaurus/[email protected]","MIT","https://github.com/facebook/docusaurus"
"@docusaurus/[email protected]","MIT","https://github.com/facebook/docusaurus"
"@mdx-js/[email protected]","MIT","https://github.com/mdx-js/mdx"
"@docusaurus/[email protected]","MIT","https://github.com/facebook/docusaurus"
"@docusaurus/[email protected]","MIT","https://github.com/facebook/docusaurus"
"@docusaurus/[email protected]","MIT","https://github.com/facebook/docusaurus"
"@mdx-js/[email protected]","MIT","https://github.com/mdx-js/mdx"
"[email protected]","MIT","https://github.com/lukeed/clsx"
"[email protected]","MIT","https://github.com/gabrielcsapo/docusaurus-plugin-image-zoom"
"[email protected]","MIT","https://github.com/FormidableLabs/prism-react-renderer"
"react-dom@17.0.2","MIT","https://github.com/facebook/react"
"react@17.0.2","MIT","https://github.com/facebook/react"
"react-dom@18.2.0","MIT","https://github.com/facebook/react"
"react@18.2.0","MIT","https://github.com/facebook/react"
39 changes: 29 additions & 10 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ const config = {
locales: ['en'],
},

markdown: {
format: "detect"
},

presets: [
[
'@docusaurus/preset-classic',
Expand Down Expand Up @@ -76,20 +80,35 @@ const config = {

plugins: [
[
'@docusaurus/plugin-content-docs',
{
id: 'community',
path: 'community',
routeBasePath: 'community',
sidebarPath: require.resolve('./community/sidebars.js'),
editUrl: 'https://github.com/apache/opendal/tree/main/website/',
},
'@docusaurus/plugin-content-docs',
{
id: 'community',
path: 'community',
routeBasePath: 'community',
sidebarPath: require.resolve('./community/sidebars.js'),
editUrl: 'https://github.com/apache/opendal/tree/main/website/',
},
],
[require.resolve("docusaurus-plugin-image-zoom"), {}],
],
[
'@docusaurus/plugin-client-redirects',
{
"redirects": [
{
"from": "/discord",
"to": "https://discord.gg/XQy8yGR2dg",
},
{
"from": "/maillist",
"to": "https://lists.apache.org/[email protected]"
},
],
},
]
],

themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
// TODO social card image
// image: 'img/opendal-social-card.jpg',
Expand Down
13 changes: 7 additions & 6 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,18 @@
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
"@docusaurus/core": "^2.4",
"@docusaurus/preset-classic": "^2.4",
"@mdx-js/react": "^1.6.22",
"@docusaurus/core": "^3.1",
"@docusaurus/plugin-client-redirects": "^3.1.1",
"@docusaurus/preset-classic": "^3.1",
"@mdx-js/react": "^3",
"clsx": "^1.2.1",
"docusaurus-plugin-image-zoom": "^0.1.1",
"prism-react-renderer": "^1.3.5",
"react": "^17.0.2",
"react-dom": "^17.0.2"
"react": "^18",
"react-dom": "^18"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "2.3.1"
"@docusaurus/module-type-aliases": "^3.1"
},
"browserslist": {
"production": [
Expand Down
Loading

0 comments on commit 7f46293

Please sign in to comment.