diff --git a/docs/ru/application.md b/docs/ru/application.md index 1d2f2eb..a20c95d 100644 --- a/docs/ru/application.md +++ b/docs/ru/application.md @@ -2,7 +2,7 @@ Рано или поздно практически на любом сайте встаёт необходимость выполнения скриптов в консоли, будь то воркеры, выполняющие в фоне ресурсоёмкие операции, или инструментарий по обслуживанию сайта. Кроме того, внедрение непрерывной -интеграции так же требует автоматизации настройки и обновления приложения. Приступая к созданию очередного консольного +интеграции также требует автоматизации настройки и обновления приложения. Приступая к созданию очередного консольного скрипта конечно же хочется свести к минимуму написание кода и уделить больше внимания основной логике. Решить все эти задачи вам поможет Console Jedi. diff --git a/docs/ru/cache.md b/docs/ru/cache.md index 6892930..50b88ba 100644 --- a/docs/ru/cache.md +++ b/docs/ru/cache.md @@ -1,7 +1,7 @@ # Кеширование Так или иначе иногда необходимо сбрасывать кеши. Чаще всего, это требуется во время разработки или тестирования приложения. -В некоторых случаях, это необходимо делать после деплоя приложения на боевые сервера. Однако, в последнем случае главное не +В некоторых случаях это необходимо делать после деплоя приложения на боевые сервера. Однако, в последнем случае главное не злоупотреблять этой возможностью: если сайт не может обновляться без сброса кешей, где-то в вашей архитектуре затаилась ошибка. Удалением кешей занимается консольная команда `cache:clear`: diff --git a/docs/ru/ci.md b/docs/ru/ci.md index cdbf8a8..05a2d6e 100644 --- a/docs/ru/ci.md +++ b/docs/ru/ci.md @@ -15,7 +15,7 @@ composer install --no-dev --prefer-dist --no-interaction ./vendor/bin/jedi env:init prod --no-interaction ``` -Консольная команда `env:init`, в отличии от [остальных команд](command.md), имеет особый алгоритм выполнения, +Консольная команда `env:init`, в отличие от [остальных команд](command.md), имеет особый алгоритм выполнения, заслуживающий отдельного объяснения: ![env:init](ci-env-init-command.jpg) diff --git a/docs/ru/environment.md b/docs/ru/environment.md index bad97bc..1fefcd9 100644 --- a/docs/ru/environment.md +++ b/docs/ru/environment.md @@ -16,7 +16,7 @@ index.php // Список существующих окружений. ``` -По-умолчанию в Console Jedi присутствует две заготовки под окружения: dev и prod. Вы можете удалить их, заменить или +По умолчанию в Console Jedi присутствует две заготовки под окружения: dev и prod. Вы можете удалить их, заменить или добавить другие. Применение настроек окружения производится через консольную команду `env:init `, вызов которой приводит к выполению @@ -24,7 +24,7 @@ index.php // Список существующих окружений. `/environments/`. Скрипт `/environments//config.php` должен возвращать массив с инструкциями по настройке окружения. Все настройки -являются необязательными, и вовсе могут отсутствовать. Поддерживаемые настройки: +являются необязательными и вовсе могут отсутствовать. Поддерживаемые настройки: Настройка | Значение | Описание --- | --- | --- @@ -88,7 +88,7 @@ return [ Попробуем на практике. Создадим окружение с кодом `r2`. 1. Создайте каталог `/environments/r2`. -1. Предположим, что в проекте в окружении r2 нужен файл `/directory/file.txt`. Поэтому, поместим его в настройки +1. Предположим, что в проекте в окружении r2 нужен файл `/directory/file.txt`. Поэтому поместим его в настройки окружения: `/environments/r2/directory/file.txt`. 1. Создайте файл с инструкциями по настройке окружения: `/environments/r2/config.php`. Данный скрипт должен возвращать массив (можно и пустой). @@ -108,12 +108,12 @@ return [ ## Рекомендации Настройки в «Битриксе» задаются двумя способами: через [`.settings*.php`](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=43&LESSON_ID=2795) -и с помощью настроек модулей. Первым способом предпочтительнее задавать неизменяемые параметры, при чём рекомендуется +и с помощью настроек модулей. Первым способом предпочтительнее задавать неизменяемые параметры, причём рекомендуется работать с файлом `.settings_extra.php`, тем самым переназначив настройки, указанные в `.settings.php`. Разместите в каталоге с окружением файл `///.settings_extra.php`, возвращающий массив, и опишите в нём необходимые данному окружению настройки. -Не смотря на то, что Console Jedi позволяет управлять настройками модулей и их регистрацией, использовать эту возможность +Несмотря на то, что Console Jedi позволяет управлять настройками модулей и их регистрацией, использовать эту возможность нужно крайне осторожно, потому что установка и удаление модулей, изменение их параметров — это операции изменения БД, которые должны производиться только через миграции. К примеру, вы просто не сможете удалить модуль из системы, используя настройки окружений. Установка модулей через настройки окружений не годна для продакшена, но хороша для дева и теста: diff --git a/docs/ru/module.md b/docs/ru/module.md index 6f08044..af9501d 100644 --- a/docs/ru/module.md +++ b/docs/ru/module.md @@ -4,7 +4,7 @@ ## Важная информация -> Не все модули поддерживают режим автоматической установки, возможны проблемы с некоторыми сторонними решениями +> Не все модули поддерживают режим автоматической установки, возможны проблемы с некоторыми сторонними решениями. Существует два способа [установки модулей](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=43&LESSON_ID=3475): @@ -14,11 +14,11 @@ * **Автоматический**. Выполняется на этапе установки продукта «1C-Битрикс: Управление сайтом». В **Console Jedi** используется этот способ. При этом последовательно вызываются методы объекта модуля `InstallDB`, `InstallEvents`, `InstallFiles`. -В документации продукта 1С-Битрикс не описана возможность такой автоматической установки, на практике же любой модуль, который положили в `/bitrix/modules/` до установки ядра, будет установлен вместе с ядром. Автоматическая установка модуля также используется при [загрузке решения из Marketplace на этапе установки](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=35&LESSON_ID=3181). +В документации продукта 1С-Битрикс не описана возможность такой автоматической установки, но на практике любой модуль, который положили в `/bitrix/modules/` до установки ядра, будет установлен вместе с ядром. Автоматическая установка модуля также используется при [загрузке решения из Marketplace на этапе установки](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=35&LESSON_ID=3181). Разработчики сторонних модулей часто реализуют только методы `DoInstall` и `DoUninstall`, тем самым, делая невозможной установку в автоматическом режиме. -> В своих модулях используйте `DoInstall` и `DoUninstall` только для вывода и обработки **пользовательского интерфейса**, а действия по установке/удалению модуля реализуйте в методах `InstallDB`, `InstallEvents`, `InstallFiles` +> В своих модулях используйте `DoInstall` и `DoUninstall` только для вывода и обработки **пользовательского интерфейса**, а действия по установке/удалению модуля реализуйте в методах `InstallDB`, `InstallEvents`, `InstallFiles`. > > Корректную реализацию смотрите в [примере класса модуля](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=43&LESSON_ID=3223). @@ -69,7 +69,7 @@ module:remove [-ct|--confirm-thirdparty] [--] ## Обновление модуля (`module:update`) -Устанавливает обновления указанного модуля из *Marketplace**. +Устанавливает обновления указанного модуля из *Marketplace*. > На данный момент установка обновлений модулей ядра не поддерживается.