seatunnel website

Site Web d'Apache Seatunnel

Anglais | 中文

Il s'agit du référentiel contenant tout le code source de https://seatunnel.apache.org . Ce guide vous guidera comment contribuer au site Web de Seatunnel.

Bifurquer

Le principal est la branche par défaut. Pour toutes les modifications, veuillez d'abord fourche, puis procédez sur la branche principale.

 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. Aperçu et générer des fichiers statiques

Ce site Web est compilé à l'aide de nœud, à l'aide de composants de framework Docusaurus

1. Télécharger et installer Nodejs (version> 14)
2. Clone le code au git clone [email protected]:apache/incubator-seatunnel-website.git
3. Exécutez ./tools/build-docs.sh pour récupérer et préparer les documents Forms Apache / incubator-Seatunnel , pour plus d'informations, vous pourriez voir comment notre document fonctionne
4. Exécutez npm install pour installer les bibliothèques dépendantes requises.
5. Exécuter npm run start in the Root Directory, vous pouvez visiter http: // localhost: 3000 pour afficher l'aperçu en mode anglais du site
6. Exécuter npm run start-zh Dans le répertoire racine, vous pouvez visiter http: // localhost: 3000 pour afficher l'aperçu du mode chinois du site
7. Pour générer des fichiers de ressources de site Web statiques, exécutez npm run build . Les ressources statiques de la construction se trouvent dans le répertoire de construction.

2. Structure du répertoire

 ├── 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. Spécification

3.1 Convention de dénomination du répertoire

Utilisez tous les minuscules, séparés par des sous-oreurs. S'il y a une structure plurielle, utilisez la nomenclature plurielle et n'utilisez pas les abréviations plurielles

Exemple positif: scripts / styles / components / images / utils / layouts / demo_styles / demo-scripts / img / doc

Counter Exemple: script / style / demoStyles / imgs / docs

3.2 JavaScript et la convention de dénomination des fichiers de ressources statiques

Tous les minuscules, séparés par un tableau de bord

Exemple positif: render-dom.js / signup.css / index.html / company-logo.png

Compteur Exemple: renderDom.js / UserManagement.html

3.3 Chemin des ressources

Les ressources d'image sont unifiées sous static/{module name}

CSS et d'autres fichiers de style sont placés dans le répertoire src/css

3,4 Page Modification du contenu

À l'exception de la page d'accueil, de l'équipe, de l'utilisateur, des documents> All Version Module Page, toutes les autres pages peuvent être directement sautées vers la page de modification des ressources GitHub correspondante via le bouton de cette page en bas

3.5 Modification de la page d'accueil

Visitez la page https://seatunnel.apache.org

Situé dans src/pages/home

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

3.6 Modification de la page d'équipe

Visitez la page https://seatunnel.apache.org/team

Situé dans src/pages/team

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

3.7 Modification de la page de liste d'utilisateurs

Visitez la page https://seatunnel.apache.org/user

Situé dans src/pages/user

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

3.8 Modification de la page de liste de versions

Visitez la page https://seatunnel.apache.org/versions

Situé dans src/pages/versions

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

3.9 Ajouter une nouvelle version pour les documents

• 1 、 Exécutez npm run version replace_by_target_version localement pour copier un document.
• 2 、 modifier /src/pages/download/st_data.json pour la dernière adresse de lien de téléchargement.