这是包含 https://seatunnel.apache.org
的所有源代码的存储库。 本指南将指导您如何为SeaTunnel的网站做出贡献。
main为默认主分支,修改请先fork到自己的仓库,然后在main分支上进行开发修改。
main 默认分支 asf-site 官网正式环境 通过https://seatunnel.apache.org 访问 asf-staging 官网测试环境 通过https://seatunnel.staged.apache.org 访问
本网站是使用node编译的,使用的是Docusaurus框架组件
git clone git@github.com:apache/incubator-seatunnel-website.git
./tools/build-docs.sh
从 apache/incubator-seatunnel 中拉取、准备文档。如果想要了解更多细节和操作请阅读文档如何工作npm install
来安装所需的依赖库。npm run start
,可以访问http://localhost:3000查看站点英文模式预览npm run start-zh
,可以访问http://localhost:3000查看站点的中文模式预览npm run build
。构建的静态资源在build目录中。├── LICENSE ├── Logo.png ├── README.md ├── README_ZH.md ├── babel.config.js ├── blog ├── user_cases ├── community // 社区 ├── docusaurus.config.js |-- download // 下载 ├── faq // Q&A ├── i18n │ └── zh-CN // 国际化中文 │ ├── docusaurus-plugin-content-blog │ ├── docusaurus-plugin-content-docs │ ├── docusaurus-plugin-content-docs-community │ ├── docusaurus-plugin-content-docs-download │ ├── docusaurus-plugin-content-docs-faq │ └── docusaurus-theme-classic ├── package.json ├── sidebars.js ├── sidebarsCommunity.js ├── src │ ├── components │ ├── css │ ├── js │ ├── pages │ │ ├── home │ │ ├── index.tsx │ │ ├── team │ │ ├── user │ │ └── versions │ └── styles ├── static // 静态资源 │ ├── doc // 文档的静态资源 │ │ ├── image // 文档通用图片 │ │ ├── image_en // 英文文档图片 │ │ └── image_zh // 中文文档图片 │ ├── home // 首页的图片 │ ├── image // 模块公用图片 │ └── user // 用户的图片 ├── tools │└── build-docs.sh // 文档同步脚本 ├── tsconfig.json ├── versioned_docs // 版本文档 │ ├── version-2.0.5 ├── versioned_sidebars // 版本 sidebars │ ├── version-2.0.5-sidebars.json ├── versions.json // 版本
全部采用小写方式, 以中下划线分隔,有复数结构时,要采用复数命名法, 缩写不用复数
正例: scripts / styles / components / images / utils / layouts / demo_styles / demo-scripts / img / doc
反例: script / style / demoStyles / imgs / docs
全部采用小写方式, 以中划线分隔
正例: render-dom.js / signup.css / index.html / company-logo.png
反例: renderDom.js / UserManagement.html
图片资源统一放在static/{模块名}
下
css等样式文件放在src/css
目录下
除了首页、团队、用户、Docs>All Version 模块页面外,其余页面都能通过底部的‘Edit this page’按钮 直接跳转至对应的github的资源修改页
访问页面 https://seatunnel.apache.org/
位于 src/pages/home
├── home ├── index.jsx ├── index.less └── languages.json
访问页面 https://seatunnel.apache.org/zh-CN/team
位于 src/pages/team
├── team ├── index.js ├── index.less └── languages.json
访问页面 https://seatunnel.apache.org/zh-CN/user/
位于 src/pages/user
├── user ├── data.json ├── images.json ├── index.js ├── index.less └── languages.json
访问页面 https://seatunnel.apache.org/zh-CN/versions/
位于 src/pages/versions
└── versions ├── config.json ├── index.js └── index.less
/src/pages/version/config.json
中的最新的版本以及历史版本。