Skip to content

Commit 4b4fec2

Browse files
authored
[website] Organizing Community Documentation with a Sidebar (#538)
1 parent 2c8b6ad commit 4b4fec2

File tree

10 files changed

+89
-5
lines changed

10 files changed

+89
-5
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "How to Contribute",
3+
"position": 2
4+
}
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
sidebar_label: Contribute Code
3+
sidebar_position: 1
4+
---
5+
6+
# Contribute Code
7+
8+
TODO
9+
10+
11+
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
sidebar_label: Contribute Documentation
3+
sidebar_position: 1
4+
---
5+
6+
# Contribute Documentation
7+
8+
TODO
9+
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# How to Contribute
6+
7+
TODO
8+
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
sidebar_label: How to Release
3+
sidebar_position: 3
4+
---
5+
6+
# How to Release
7+
8+
TODO
9+
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
sidebar_label: Welcome
3+
sidebar_position: 1
4+
---
5+
16
# Welcome to Fluss Community
27

38
## Issues

website/docusaurus.config.ts

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ const config: Config = {
5656
{
5757
docs: {
5858
sidebarPath: './sidebars.ts',
59-
editUrl: ({versionDocsDirPath, docPath}) =>
60-
`https://github.com/alibaba/fluss/tree/main/website/docs/${docPath}`,
59+
editUrl: ({docPath}) =>
60+
`https://github.com/alibaba/fluss/edit/main/website/docs/${docPath}`,
6161
remarkPlugins: [versionReplace],
6262
},
6363
blog: {
@@ -77,6 +77,19 @@ const config: Config = {
7777
],
7878
],
7979
plugins: [
80+
[
81+
'@docusaurus/plugin-content-docs',
82+
{
83+
id: 'community',
84+
path: 'community',
85+
routeBasePath: 'community',
86+
sidebarPath: './sidebarsCommunity.js',
87+
editUrl: ({docPath}) => {
88+
return `https://github.com/alibaba/fluss/edit/main/website/community/${docPath}`;
89+
},
90+
// ... other options
91+
},
92+
],
8093
[
8194
'@docusaurus/plugin-pwa',
8295
{
@@ -115,7 +128,7 @@ const config: Config = {
115128
label: 'Docs',
116129
},
117130
{to: '/blog', label: 'Blog', position: 'left'},
118-
{to: '/community', label: 'Community', position: 'left'},
131+
{to: '/community/welcome', label: 'Community', position: 'left'},
119132
{to: '/roadmap', label: 'Roadmap', position: 'left'},
120133
{to: '/downloads', label: 'Downloads', position: 'left'},
121134
{

website/sidebarsCommunity.js

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
/*
2+
* Copyright (c) 2025 Alibaba Group Holding Ltd.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
18+
export default {
19+
community: [
20+
{
21+
type: 'autogenerated',
22+
dirName: '.',
23+
}
24+
],
25+
};

website/src/pages/roadmap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ This transition aims to streamline operations and enhance system reliability.
3333

3434
- Support for complex data types: Array ([#168](https://github.com/alibaba/fluss/issues/168)), Map ([#169](https://github.com/alibaba/fluss/issues/169)), Struct ([#170](https://github.com/alibaba/fluss/issues/170)), Variant/JSON.
3535
- Support for schema evolution.
36-
- Support for secondary index for Delta Join with Flink ([#65](https://github.com/alibaba/fluss/issues/65)).
36+
- Support for secondary index for Delta Join with Flink (~~[#65](https://github.com/alibaba/fluss/issues/65)~~).
3737
- Support for buckets rescale.
3838

3939
## Zero Disks

website/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import useRouteContext from '@docusaurus/useRouteContext';
2222
export default function DocsVersionDropdownNavbarItemWrapper(props) {
2323
const {plugin} = useRouteContext();
2424

25-
if (plugin.name === "docusaurus-plugin-content-docs") {
25+
if (plugin.name === "docusaurus-plugin-content-docs" && plugin.id !== "community") {
2626
return (
2727
<>
2828
<DocsVersionDropdownNavbarItem {...props} />

0 commit comments

Comments
 (0)