Этот сайт — перевод оригинальной документации по dbt. Приглашаем всех желающих вносить правки и улучшения в перевод, чтобы сделать его точнее и полезнее для сообщества.
Если вы заметили неточность или хотите помочь, присылайте правки в репозиторий: https://github.com/Inzhenerka/docs.getdbt.tech
Или напишите в поддержку: https://t.me/inzhenerkatech_sup
Сайт полностью дублирует оригинальный, поэтому для перевода любой страницы достаточно заменить адрес https://docs.getdbt.com на https://docs.getdbt.tech.
Мы используем docusaurus для сайта docs.getdbt.tech.
- Перевод документации dbt - Содержание
- Кодекс поведения
- Вклад в проект
- Написание документации
- Локальный запуск сайта документации
Пожалуйста, ознакомьтесь с кодексом поведения для участников документации dbt. Создание инклюзивной и справедливой среды для нашей документации важнее любого другого аспекта. Синтаксические ошибки можно исправить, но доверие, однажды потерянное, очень трудно вернуть.
Мы приветствуем вклад членов сообщества в этот репозиторий:
- Исправления: если вы заметили ошибку, вы можете использовать кнопку
Edit this pageвнизу каждой страницы, чтобы предложить правку. - Новая документация: если вы внесли вклад в код dbt-core, мы рекомендуем также написать документацию здесь! Обратитесь в сообщество dbt, если нужна помощь, чтобы найти подходящее место для этих материалов.
- Крупные переработки: вы можете создать issue, чтобы предложить идеи для раздела документации, который требует внимания.
Вы можете использовать компоненты, описанные в библиотеке docusaurus.
Документация dbt Labs написана на Markdown и иногда на HTML. При написании материалов ориентируйтесь на style guide и типы контента, чтобы понимать наши стандарты и то, как мы структурируем информацию в продуктовой документации.
Все PR, которые отправляются, будут проверены командой документации dbt Labs на предмет редакторского качества.
Контент, который отправляют пользователи и open-source сообщество, также проходит проверку у наших subject matter experts (SME), чтобы обеспечить техническую корректность.
Теперь вы можете переиспользовать контент между разными страницами документации и версиями, а также задавать product variables в документации dbt Labs. Подробнее о том, как организовать single-sourcing контента между версиями, product variables и другим контентом, см. Single-sourcing content.
Вы можете добавлять сниппеты кода и другой контент в виде табов. Подробнее см. Adding page components.
Вы можете перейти по ссылке из комментария Vercel bot в PR, чтобы посмотреть ваши изменения на staging-сервере. Также вы можете просматривать предлагаемые правки локально на своем компьютере. В наших инструкциях для настройки используется homebrew:
- (Mac Terminal) Установите Xcode Command Line Tools
- Откройте терминал, выполните
xcode-select --installи следуйте инструкциям в появившемся окне.
- Откройте терминал, выполните
- (Mac и Linux) Установите homebrew
- Скопируйте и вставьте
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"в терминал и следуйте инструкциям. После завершения установки выполните шаги Next Steps, которые терминал выведет в конце.
- Скопируйте и вставьте
- (Windows) Установите Node.js
- (только для Mac и Linux) Установите
node:brew install node - Склонируйте репозиторий:
git clone https://github.com/dbt-labs/docs.getdbt.com.git - Перейдите в репозиторий:
cd docs.getdbt.com - Перейдите в поддиректорию
website:cd website - Установите необходимые node-пакеты:
make installилиbun install(опционально — установить обновления) - Запустите сайт:
make runилиbun start - Перед тем как пушить изменения в ветку, запустите
make buildилиbun run buildи проверьте, что все ссылки работают
Примечание:
- Если при запуске
bun installвы получаете ошибкуfatal error: 'vips/vips8' file not found, возможно, нужно выполнитьbrew install vips. Предупреждение: это займет время — можно пойти за кофе!