Как помочь проекту
Исправляйте неточности, добавляйте полезные команды и помогайте поддерживать русскую и английскую версии синхронными.
Быстрый способ
- Откройте репозиторий на GitHub.
- Создайте fork и новую ветку для изменения.
- Обновите соответствующие файлы в
ru/иeng/. - Запустите локальные проверки.
- Откройте pull request с коротким описанием.
Локальная проверка
ruby scripts/build_search_index.rb
ruby scripts/check_repo.rb
node --check assets/app.js
node --check assets/docs.js
Что можно улучшить
- добавить полезную команду или практический сценарий;
- исправить устаревший флаг
kubectl; - улучшить перевод или описание;
- сообщить о неработающей ссылке;
- улучшить доступность и мобильную версию сайта.
Правила контента
- Добавляйте команды сразу в русскую и английскую версии.
- Сохраняйте одинаковый порядок разделов.
- Не публикуйте реальные токены, адреса кластеров и другие секреты.
- Для опасных команд поясняйте последствия.
- Используйте понятные placeholders:
<pod-name>,<namespace>,<deployment>.
Сообщить о проблеме
Для ошибки или предложения создайте issue. Для готового исправления сразу открывайте pull request.