seatunnel website

Site Apache Seatunnel

Inglês | 中文

Este é o repositório que contém todo o código -fonte de https://seatunnel.apache.org . Este guia o guiará como contribuir para o site da Seatunnel.

Filial

Principal é a ramificação padrão. Para todas as modificações, bire primeiro e depois prossiga no ramo 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. Visualizar e gerar arquivos estáticos

Este site é compilado usando o nó, usando componentes da estrutura Docusaurus

1. Baixe e instale o NodeJS (versão> 14)
2. Clone o código para o git clone [email protected]:apache/incubator-seatunnel-website.git
3. Run ./tools/build-docs.sh para buscar e preparar documentos formam apache/incubator-seatunnel , para obter mais informações, você pode ver como nosso documento funciona
4. Execute npm install para instalar as bibliotecas dependentes necessárias.
5. Execute npm run start no diretório raiz, você pode visitar http: // localhost: 3000 para ver a visualização do modo inglês do site
6. Execute npm run start-zh no diretório raiz, você pode visitar http: // localhost: 3000 para visualizar a visualização do modo chinês do site
7. Para gerar arquivos de recursos do site estático, execute npm run build . Os recursos estáticos da construção estão no diretório de compilação.

2. Estrutura do diretório

 ├── 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. Especificação

3.1 Convenção de Nomeação do Diretório

Use todos os minúsculos, separados por sublinhados. Se houver uma estrutura plural, use a nomenclatura plural e não use abreviações plurais

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

Exemplo de contador: script / style / demoStyles / imgs / docs

3.2 JavaScript e a Convenção de Nomeação de Arquivos de Recursos estáticos

Toda a minúscula, separada por uma corrida

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

Exemplo de contador: renderDom.js / UserManagement.html

3.3 Caminho de recursos

Os recursos de imagem são unificados em static/{module name}

CSS e outros arquivos de estilo são colocados no diretório src/css

3.4 Modificação de conteúdo de página

Exceto pela página inicial, equipe, usuário, documentos> Página do módulo de versão, todas as outras páginas podem ser puladas diretamente para a página de modificação de recursos do github correspondente através do botão desta página '

3.5 Modificação da página inicial

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

Localizado em src/pages/home

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

3.6 Modificação da página da equipe

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

Localizado em src/pages/team

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

3.7 Modificação da página da lista de usuários

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

Localizado em src/pages/user

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

3.8 Lista de versão Modificação da página

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

Localizado em src/pages/versions

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

3.9 Adicione uma nova versão para documentos

• 1 、 Execute npm run version replace_by_target_version Localmente para copiar um documento.
• 2 、 Modify /src/pages/download/st_data.json para obter o endereço de link de download mais recente.