seatunnel website

Sitio web de Apache Seatunnel

Inglés | 中文

Este es el repositorio que contiene todo el código fuente de https://seatunnel.apache.org . Esta guía le guiará cómo contribuir al sitio web de SeatUnnel.

Rama

Main es la rama predeterminada. Para todas las modificaciones, bifurca primero y luego continúe con la rama principal.

 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. Vista previa y generar archivos estáticos

Este sitio web se compila utilizando el nodo, utilizando los componentes de Docusaurus Framework

1. Descargar e instalar NodeJS (Versión> 14)
2. Clon el código para el git clone [email protected]:apache/incubator-seatunnel-website.git
3. Ejecutar ./tools/build-docs.sh para buscar y preparar documentos apache/incubator-seatunnel , para obtener más información, puede ver cómo funciona nuestro documento
4. Ejecute npm install para instalar las bibliotecas dependientes requeridas.
5. Ejecutar npm run start en el directorio raíz, puede visitar http: // localhost: 3000 para ver la vista previa del modo inglés del sitio
6. Ejecutar npm run start-zh en el directorio raíz, puede visitar http: // localhost: 3000 para ver la vista previa del modo chino del sitio
7. Para generar archivos de recursos de sitio web estáticos, ejecute npm run build . Los recursos estáticos de la construcción están en el directorio de compilación.

2. Estructura del directorio

 ├── 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. Especificación

3.1 Convención de nombres de directorio

Use todos los minúsculas, separados por subrayos. Si hay una estructura plural, use la nomenclatura plural y no use abreviaturas plurales

Ejemplo positivo: scripts / styles / components / images / utils / layouts / demo_styles / demo-scripts / img / doc

Ejemplo de mostrador: script / style / demoStyles / imgs / docs

3.2 JavaScript y la convención de nombres de archivos de recursos estáticos

Todos minúsculas, separados por un tablero

Ejemplo positivo: render-dom.js / signup.css / index.html / company-logo.png

Ejemplo de contador: renderDom.js / UserManagement.html

3.3 Ruta de recursos

Los recursos de imagen se unifican en static/{module name}

CSS y otros archivos de estilo se colocan en el directorio src/css

Modificación de contenido de 3.4 página

A excepción de la página de inicio, el equipo, el usuario, los documentos> la página del módulo de versión, todas las demás páginas se pueden saltar directamente a la página de modificación de recursos GitHub correspondiente a través del botón 'edit esta página' en la parte inferior

3.5 Modificación de la página de inicio

Visite la página https://seatunnel.apache.org

Ubicado en src/pages/home

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

3.6 Modificación de la página del equipo

Visite la página https://seatunnel.apache.org/team

Ubicado en src/pages/team

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

3.7 Modificación de la página de la lista de usuarios

Visite la página https://seatunnel.apache.org/user

Ubicado en src/pages/user

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

3.8 Modificación de la página de la lista de versiones

Visite la página https://seatunnel.apache.org/versions

Ubicado en src/pages/versions

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

3.9 Agregue una nueva versión para documentos

• 1 、 Ejecutar npm run version replace_by_target_version localmente para copiar un documento.
• 2 、 Modificar /src/pages/download/st_data.json para la última dirección de enlace de descarga.