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用於最新的下載鏈接地址。