From 1e73052c091ce20a2923c69afabd7341daa5f125 Mon Sep 17 00:00:00 2001 From: neverland Date: Mon, 6 May 2024 22:24:34 +0800 Subject: [PATCH] docs: add community overview page (#2274) --- website/docs/en/_meta.json | 2 +- website/docs/en/community/_meta.json | 1 + website/docs/en/community/index.mdx | 35 +++++++++++++++++++ website/docs/en/community/releases/index.mdx | 4 +-- .../en/guide/advanced/module-federation.mdx | 2 +- website/docs/zh/_meta.json | 2 +- website/docs/zh/community/_meta.json | 1 + website/docs/zh/community/index.mdx | 35 +++++++++++++++++++ website/docs/zh/community/releases/index.mdx | 2 +- 9 files changed, 78 insertions(+), 6 deletions(-) create mode 100644 website/docs/en/community/index.mdx create mode 100644 website/docs/zh/community/index.mdx diff --git a/website/docs/en/_meta.json b/website/docs/en/_meta.json index 5698960393..ee37c013c3 100644 --- a/website/docs/en/_meta.json +++ b/website/docs/en/_meta.json @@ -21,7 +21,7 @@ }, { "text": "Community", - "link": "/community/releases/", + "link": "/community/", "activeMatch": "/community/" } ] diff --git a/website/docs/en/community/_meta.json b/website/docs/en/community/_meta.json index fcc1578235..b8f833d9eb 100644 --- a/website/docs/en/community/_meta.json +++ b/website/docs/en/community/_meta.json @@ -1,4 +1,5 @@ [ + "index", { "type": "dir", "name": "releases", diff --git a/website/docs/en/community/index.mdx b/website/docs/en/community/index.mdx new file mode 100644 index 0000000000..b4947e996d --- /dev/null +++ b/website/docs/en/community/index.mdx @@ -0,0 +1,35 @@ +# Community + +## Version + +Rsbuild follows the Semantic Versioning specification. + +For more details, see [Releases](/community/releases/index). + +## Team + +The development of Rsbuild is driven by ByteDance's Rspack team and community contributors. + +For information about the team members, please refer to [Rspack - Core team](https://www.rspack.dev/misc/team/core-team). + +## Communication + +You can communicate with the developers of Rsbuild through the following channels: + +- [GitHub Discussions](https://github.com/web-infra-dev/rsbuild/discussions) +- [Discord](https://discord.com/invite/XsaKEEk4mW) +- [Twitter](https://twitter.com/rspack_dev) + +## Contribution + +Contributions to Rsbuild are welcomed! + +Please refer to the [Rsbuild Contribution Guide](https://github.com/web-infra-dev/rsbuild/blob/main/CONTRIBUTING.md). + +## Blogs + +Please visit [Rspack - Blog](https://www.rspack.dev/blog/index) to read our latest articles and announcements. + +## Examples + +Please visit [rspack-contrib/rspack-examples](https://github.com/rspack-contrib/rspack-examples) to view or contribute to the example projects of Rsbuild. diff --git a/website/docs/en/community/releases/index.mdx b/website/docs/en/community/releases/index.mdx index 4c50807bda..ba5a7feb31 100644 --- a/website/docs/en/community/releases/index.mdx +++ b/website/docs/en/community/releases/index.mdx @@ -6,7 +6,7 @@ Please visit [GitHub - release](https://github.com/web-infra-dev/rsbuild/release ## Semantic Version -Rsbuild follows the [Semantic Versioning](https://semver.org/lang/zh-CN/) semantic version specification. +Rsbuild follows the [Semantic Versioning](https://semver.org/) specification. - Major version: contains incompatible API changes. - Minor version: contains backward compatible features and fixes. @@ -19,4 +19,4 @@ Rsbuild is currently in 0.x version, so minor version may also contain some brea ## Release cycle - Rsbuild will release several patch versions every week. -- We plan to launch Rsbuild 1.0 stable version and based on Rspack 1.0 in the **Q2 2024**. +- We plan to launch Rsbuild 1.0 stable version and based on Rspack 1.0 in the **July 2024**. diff --git a/website/docs/en/guide/advanced/module-federation.mdx b/website/docs/en/guide/advanced/module-federation.mdx index a452ea32f7..96136bf84a 100644 --- a/website/docs/en/guide/advanced/module-federation.mdx +++ b/website/docs/en/guide/advanced/module-federation.mdx @@ -55,7 +55,7 @@ export default defineConfig({ }); ``` -Please refer to the [Module Federation v2.0 documentation](https://module-federation.io/zh/) for details usage. +Please refer to the [Module Federation v2.0 documentation](https://module-federation.io/) for details usage. ## Example Repositories diff --git a/website/docs/zh/_meta.json b/website/docs/zh/_meta.json index 45bc88d1be..360a342f45 100644 --- a/website/docs/zh/_meta.json +++ b/website/docs/zh/_meta.json @@ -21,7 +21,7 @@ }, { "text": "社区", - "link": "/community/releases/", + "link": "/community/", "activeMatch": "/community/" } ] diff --git a/website/docs/zh/community/_meta.json b/website/docs/zh/community/_meta.json index 33b1f6417b..f960104e84 100644 --- a/website/docs/zh/community/_meta.json +++ b/website/docs/zh/community/_meta.json @@ -1,4 +1,5 @@ [ + "index", { "type": "dir", "name": "releases", diff --git a/website/docs/zh/community/index.mdx b/website/docs/zh/community/index.mdx new file mode 100644 index 0000000000..a4c7cfee0a --- /dev/null +++ b/website/docs/zh/community/index.mdx @@ -0,0 +1,35 @@ +# 社区 + +## 版本 + +Rsbuild 遵循 Semantic Versioning 语义化版本规范。 + +请查看 [版本发布](/community/releases/index) 了解更多。 + +## 团队 + +Rsbuild 的开发是由 ByteDance 的 Rspack 团队和社区贡献者驱动的。 + +请查看 [Rspack - 核心团队](https://www.rspack.dev/zh/misc/team/core-team) 来了解团队成员的信息。 + +## 交流 + +你可以通过以下渠道与 Rsbuild 的开发者进行交流： + +- [GitHub Discussions](https://github.com/web-infra-dev/rsbuild/discussions) +- [Discord](https://discord.com/invite/XsaKEEk4mW) +- [Twitter](https://twitter.com/rspack_dev) + +## 贡献 + +欢迎参与 Rsbuild 贡献！ + +请参考 [Rsbuild Contribution Guide](https://github.com/web-infra-dev/rsbuild/blob/main/CONTRIBUTING.md)。 + +## 博客 + +请访问 [Rspack - 博客](https://www.rspack.dev/zh/blog/index) 来阅读我们的最新文章和发布公告。 + +## 示例 + +请访问 [rspack-contrib/rspack-examples](https://github.com/rspack-contrib/rspack-examples) 来查看或贡献 Rsbuild 的示例项目。 diff --git a/website/docs/zh/community/releases/index.mdx b/website/docs/zh/community/releases/index.mdx index adeb8ffb08..b56099026a 100644 --- a/website/docs/zh/community/releases/index.mdx +++ b/website/docs/zh/community/releases/index.mdx @@ -19,4 +19,4 @@ Rsbuild 当前处于 0.x 版本，因此次版本号也会包含一些不兼容 ## 发版周期 - Rsbuild 通常会在每周发布若干个 patch 版本。 -- 我们计划于 **2024 年第 2 季度**：发布 Rsbuild 1.0 稳定版本，并基于 Rspack 1.0。 +- 我们计划于 **2024 年 7 月**：发布 Rsbuild 1.0 稳定版本，并基于 Rspack 1.0。