seatunnel website

Situs web Apache Seatunnel

Bahasa Inggris | 中文

Ini adalah repositori yang berisi semua kode sumber https://seatunnel.apache.org . Panduan ini akan memandu Anda cara berkontribusi ke situs web Seatunnel.

Cabang

Utama adalah cabang default. Untuk semua modifikasi, silakan garpu terlebih dahulu, dan kemudian lanjutkan di cabang utama.

 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. Pratinjau dan hasilkan file statis

Situs web ini dikompilasi menggunakan Node, menggunakan komponen kerangka kerja DocusAurus

1. Unduh dan Instal Nodejs (Versi> 14)
2. Klon Kode ke git clone [email protected]:apache/incubator-seatunnel-website.git
3. Jalankan ./tools/build-docs.sh untuk mengambil dan menyiapkan dokumen dari apache/inkubator-seatunnel , untuk informasi lebih lanjut Anda dapat melihat cara kerja dokumen kami
4. Jalankan npm install untuk menginstal pustaka dependen yang diperlukan.
5. Jalankan npm run start di direktori root, Anda dapat mengunjungi http: // localhost: 3000 untuk melihat pratinjau mode bahasa Inggris dari situs tersebut
6. Jalankan npm run start-zh di direktori root, Anda dapat mengunjungi http: // localhost: 3000 untuk melihat pratinjau mode Cina dari situs tersebut
7. Untuk menghasilkan file sumber daya situs web statis, jalankan npm run build . Sumber daya statis pembangunan ada di direktori build.

2. Struktur Direktori

 ├── 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. Spesifikasi

3.1 Konvensi Penamaan Direktori

Gunakan semua huruf kecil, dipisahkan oleh garis bawah. Jika ada struktur jamak, gunakan nomenklatur jamak, dan jangan gunakan singkatan jamak

Contoh Positif: scripts / styles / components / images / utils / layouts / demo_styles / demo-scripts / img / doc

Contoh penghitung: script / style / demoStyles / imgs / docs

3.2 JavaScript dan Konvensi Penamaan File Sumber Daya Statis

Semua huruf kecil, dipisahkan dengan tanda hubung

Contoh Positif: render-dom.js / signup.css / index.html / company-logo.png

Contoh penghitung: renderDom.js / UserManagement.html

3.3 Jalur Sumber Daya

Sumber daya gambar disatukan di bawah static/{module name}

CSS dan file gaya lainnya ditempatkan di direktori src/css

3.4 Modifikasi Konten Halaman

Kecuali untuk beranda, tim, pengguna, dokumen> semua halaman modul versi, semua halaman lain dapat langsung dilompati ke halaman modifikasi sumber daya GitHub yang sesuai melalui tombol 'halaman ini' di bagian bawah

3.5 Modifikasi Halaman Beranda

Kunjungi halaman https://seatunnel.apache.org

Terletak di src/pages/home

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

3.6 Modifikasi Halaman Tim

Kunjungi halaman https://seatunnel.apache.org/team

Terletak di src/pages/team

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

3.7 Modifikasi Halaman Daftar Pengguna

Kunjungi halaman https://seatunnel.apache.org/user

Terletak di src/pages/user

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

3.8 Modifikasi Halaman Daftar Versi

Kunjungi halaman https://seatunnel.apache.org/versions

Terletak di src/pages/versions

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

3.9 Tambahkan versi baru untuk dokumen

• 1 、 Jalankan npm run version replace_by_target_version secara lokal untuk menyalin dokumen.
• 2 、 odify /src/pages/download/st_data.json untuk alamat tautan unduhan terbaru.