seatunnel website

Apache Seatunnel -Website

Englisch | 中文

Dies ist das Repository, das den gesamten Quellcode von https://seatunnel.apache.org enthält. In diesem Leitfaden leiten Sie, wie Sie zur Seatunnel -Website beitragen.

Zweig

Main ist der Standardzweig. Für alle Modifikationen geben Sie zuerst bitte auf und fahren Sie dann mit der Hauptzweigung fort.

 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. Vorschau und generieren statische Dateien

Diese Website wird mit dem Knoten mithilfe von Docusaurus Framework -Komponenten kompiliert

1. Download und installieren Sie NodeJs (Version> 14)
2. Klonen Sie den Code in den lokalen git clone [email protected]:apache/incubator-seatunnel-website.git
3. Run ./tools/build-docs.sh um DOCs Form Apache/Inkubator-Seatunnel zu holen und vorzubereiten. Weitere Informationen können sehen, wie unser Dokument funktioniert
4. Führen Sie npm install aus, um die erforderlichen abhängigen Bibliotheken zu installieren.
5. Führen Sie npm run start im Stammverzeichnis können Sie http: // localhost: 3000 besuchen, um die englische Modus -Vorschau der Website anzuzeigen
6. Führen Sie npm run start-zh im Root-Verzeichnis auszuführen. Sie können http: // localhost: 3000 besuchen, um die chinesische Modus-Vorschau der Website anzuzeigen
7. Um statische Website -Ressourcendateien zu generieren, führen Sie npm run build aus. Die statischen Ressourcen des Builds befinden sich im Build -Verzeichnis.

2. Verzeichnisstruktur

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

1. Spezifikation

3.1 Verzeichnis -Benennungskonvention

Verwenden Sie alle Kleinbuchstaben, die durch Unterstriche getrennt sind. Wenn es eine Pluralstruktur gibt, verwenden Sie die Plural -Nomenklatur und verwenden Sie keine Abkürzungen der Plural

Positives Beispiel: scripts / styles / components / images / utils / layouts / demo_styles / demo-scripts / img / doc

Gegenbeispiel: script / style / demoStyles / imgs / docs

3.2 JavaScript und die Namenskonvention statischer Ressourcendateien

Alle Kleinbuchstaben, getrennt durch einen Armaturenbrett

Positives Beispiel: render-dom.js / signup.css / index.html / company-logo.png

Gegenbeispiel: renderDom.js / UserManagement.html

3.3 Ressourcenpfad

Bildressourcen sind unter static/{module name} einheitlich

CSS und andere Stildateien werden im src/css -Verzeichnis platziert

3.4 Seiteninhaltsänderung

Mit Ausnahme der Homepage-, Team-, Benutzer-, Dokument-

3.5 Homepagesänderung

Besuchen Sie die Seite https://seatunnel.apache.org

Befindet sich in src/pages/home

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

3.6 Teamseitenänderung

Besuchen Sie die Seite https://seatunnel.apache.org/team

Befindet sich in src/pages/team

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

3.7 Änderung der Benutzerliste

Besuchen Sie die Seite https://seatunnel.apache.org/user

Befindet sich in src/pages/user

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

3.8 Versionslistenseite Änderung

Besuchen Sie die Seite https://seatunnel.apache.org/versions

Befindet sich in src/pages/versions

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

3.9 Fügen Sie eine neue Version für Dokumente hinzu

• 1 、 Führen Sie npm run version replace_by_target_version aus.
• 2 、 modify /src/pages/download/st_data.json für die neueste Download -Link -Adresse.