seatunnel website

Apache座椅网站

英语| 中文

这是包含https://seatunnel.apache.org的所有源代码的存储库。本指南将指导您如何为座椅网站贡献。

分支

主要是默认分支。对于所有修改，请先分配，然后继续进行主分支。

 main #default branch
asf-site   #The official environment of asf-site official website is accessed through https://seatunnel.apache.org
asf-staging #The asf-staging official website test environment is accessed through https://seatunnel.staged.apache.org

1。预览和生成静态文件

该网站是使用节点编译的，使用docusaurus框架组件

1. 下载并安装nodejs（版本> 14）
2. 克隆代码到本地git clone [email protected]:apache/incubator-seatunnel-website.git
3. 运行./tools/build-docs.sh以获取和准备文档形式Apache/Incubator-seactunnel ，有关更多信息，您可以看到我们的文档如何工作
4. 运行npm install以安装所需的因库。
5. 在根目录中运行npm run start ，您可以访问http：// localhost：3000查看网站的英语模式预览
6. 在根目录中运行npm run start-zh ，您可以访问http：// localhost：3000来查看网站的中文模式预览
7. 要生成静态网站资源文件，请运行npm run build 。构建的静态资源在构建目录中。

2。目录结构

 ├── LICENSE
├── Logo.png
├── README.md
├── README_ZH.md
├── babel.config.js
├── blog
├── user_cases
├── community  // Community
├── docusaurus.config.js
|-- download  // Download
├── faq  // Q&A
├── i18n
│       └── zh-CN  // Internationalized Chinese
│           ├── 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  // static resources
│       ├── doc  // Static resources for documentation
│       │       ├── image  // Document common image
│       │       ├── image_en  // English document picture
│       │       └── image_zh  // Chinese document picture
│       ├── home  // Homepage pictures
│       ├── image  // Module common pictures
│       └── user  // user picture
├── tools
        │└── build-docs.sh  // Document sync script
├── tsconfig.json
├── versioned_docs  // Version documentation
│       ├── version-2.0.5
├── versioned_sidebars  // Version sidebars
│       ├── version-2.0.5-sidebars.json
├── versions.json  // Version

3。规格

3.1目录命名大会

使用所有小写，由下划线分开。如果有复数结构，请使用复数命名法，并且不使用复数缩写

正面示例： scripts / styles / components / images / utils / layouts / demo_styles / demo-scripts / img / doc

计数器示例： script / style / demoStyles / imgs / docs

3.2 JavaScript和静态资源文件的命名约定

所有小写​​，被破折号隔开

阳性示例： render-dom.js / signup.css / index.html / company-logo.png

计数器示例： renderDom.js / UserManagement.html

3.3资源路径

图像资源是在static/{module name}下统一的

CSS和其他样式文件放置在src/css目录中

3.4页面内容修改

除主页，团队，用户，文档>所有版本模块页面外

3.5主页修改

访问页面https://seatunnel.apache.org

位于src/pages/home

 ├── home
        ├── index.jsx
        ├── index.less
        └── languages.json

3.6团队页面修改

访问页面https://seatunnel.apache.org/team

位于src/pages/team中

 ├── team
        ├── index.js
        ├── index.less
        └── languages.json

3.7用户列表页面修改

访问页面https://seatunnel.apache.org/user

位于src/pages/user中

 ├── user
        ├── data.json
        ├── images.json
        ├── index.js
        ├── index.less
        └── languages.json

3.8版本列表页面修改

访问页面https://seatunnel.apache.org/versions

位于src/pages/versions中

 └── versions
        ├── config.json
        ├── index.js
        └── index.less

3.9为文档添加新版本

• 1，运行npm run version replace_by_target_version本地复制文档。
• 2，modify /src/pages/download/st_data.json /pages/download/st_data.json用于最新的下载链接地址。