seatunnel website

Сайт Apache Seatunnel

Английский | 中文

Это репозиторий, содержащий весь исходный код https://seatunnel.apache.org . Это руководство даст вам, как внести свой вклад на веб -сайт Seatunnel.

Ветвь

Главное - филиал по умолчанию. Для всех модификаций сначала разделите, а затем перейдите в главную филиал.

 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. Предварительный просмотр и генерируйте статические файлы

Этот веб -сайт составлен с использованием узла с использованием компонентов Docusaurus Framework

1. Скачать и установить Nodejs (версия> 14)
2. Клонировать код локальному git clone [email protected]:apache/incubator-seatunnel-website.git
3. Запустите ./tools/build-docs.sh для получения и подготовки документов с Apache/Incubator-seatunnel для получения дополнительной информации вы можете увидеть, как работает наш документ
4. Запустите npm install , чтобы установить необходимые зависимые библиотеки.
5. Запустите npm run start в корневом каталоге, вы можете посетить http: // localhost: 3000, чтобы просмотреть предварительный просмотр английского режима сайта
6. Запустите npm run start-zh в корневом каталоге, вы можете посетить http: // localhost: 3000, чтобы просмотреть предварительный просмотр режима китайского режима сайта
7. Чтобы сгенерировать статические файлы ресурсов веб -сайта, запустите npm run build . Статические ресурсы сборки находятся в каталоге сборки.

2. Структура каталога

 ├── 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. Спецификация

3.1 Конвенция по именованию каталогов

Используйте все строчные, разделенные подчеркиванием. Если есть структура во множественном числе, используйте номенклатуру множественного числа и не используйте аббревиатуры множественного числа

Положительный пример: scripts / styles / components / images / utils / layouts / demo_styles / demo-scripts / img / doc

Счетчик Пример: script / style / demoStyles / imgs / docs

3.2 JavaScript и соглашение об именах статических ресурсов файлов

Все строчные, разделенные чертой

Положительный пример: render-dom.js / signup.css / index.html / company-logo.png

Счетчик Пример: renderDom.js / UserManagement.html

3.3 Путь ресурса

Ресурсы изображения объединены под static/{module name}

CSS и другие файлы стиля размещаются в каталоге src/css

3.4 Изменение контента страницы

За исключением страниц домашней страницы, команды, пользователя, документов> всех версий модуля, все остальные страницы могут быть непосредственно подпрыгнуты на соответствующую страницу модификации ресурсов GitHub через кнопку «Edith» внизу внизу внизу

3.5 Модификация домашней страницы

Посетите страницу https://seatunnel.apache.org

Расположен в src/pages/home

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

3.6 Модификация страницы команды

Посетите страницу https://seatunnel.apache.org/team

Расположен в src/pages/team

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

3.7 Модификация страницы списка пользователей

Посетите страницу https://seatunnel.apache.org/user

Расположен в src/pages/user

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

3.8 Модификация списка версий

Посетите страницу https://seatunnel.apache.org/versions

Расположен в src/pages/versions

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

3.9 Добавьте новую версию для документов

• 1 、 Запустите npm run version replace_by_target_version локально для копирования документа.
• 2 、 Modify /src/pages/download/st_data.json для последнего адреса загрузки.