Update formatting for 8.x

salesagility · Mar 12, 2024 · d2acc8f · d2acc8f
1 parent 2b00729
commit d2acc8f
Show file tree

Hide file tree

Showing 9 changed files with 77 additions and 104 deletions.
diff --git a/content/8.x/admin/configuration/LDAP-Configuration.ru.adoc b/content/8.x/admin/configuration/LDAP-Configuration.ru.adoc
@@ -222,10 +222,9 @@ parameters:
 После выполнения действий, необходимых для добавления секретов, вы можете изменить конфигурацию LDAP таким образом, чтобы некоторые настройки сохранялись в секретах. Следующие шаги могут быть использованы в качестве примера:
 
  . *Добавьте секрет для закрытого ключа LDAP*
-
++
 Из корневой папки системы выполните команду `php bin/console secrets:set LDAP_SEARCH_PASSWORD` и после приглашения укажите необходимое значение.
-
-[start=2]
++
  . *<<Очистка кеша Symfony,Очистите кеш  Symfony>>*
 
 == Очистка кеша Symfony 

diff --git a/content/8.x/admin/configuration/SAML-Configuration.ru.adoc b/content/8.x/admin/configuration/SAML-Configuration.ru.adoc
@@ -212,22 +212,20 @@ hslavich_onelogin_saml:
 После выполнения действий, необходимых для добавления секретов, вы можете изменить конфигурацию SAML таким образом, чтобы некоторые настройки сохранялись в секретах. Следующие шаги могут быть использованы в качестве примера:
 
  . *Добавьте секрет для закрытого ключа поставщика услуг (SP)*
-
++
 Из корневой папки системы выполните команду `php bin/console secrets:set SAML_SP_PRIVATE_KEY` и после приглашения укажите ключ.
-
-[start=2]
++
  . *Добавьте секрет для сертификата SP*
-
++
 Из корневой папки системы выполните команду `php bin/console secrets:set SAML_SP_CERT` и после приглашения укажите сертификат.
-
-[start=3]
++
  . *Отредактируйте файл `hslavich_onelogin_saml.yaml`*
-
++
 Наконец, измените  *пользовательскую* копию файла
  `hslavich_onelogin_saml.yaml`, прописав в нём необходимые значения.
-
++
 Следующий пример — всего лишь фрагмент вышеуказанного файла:
-
++
 [source,yaml]
 ----
 hslavich_onelogin_saml:
@@ -248,12 +246,10 @@ hslavich_onelogin_saml:
     # ...
 ----
 
-[start=4]
  . *При необходимости добавьте другие настройки в секреты*
-
++
 Есть и другие значения, которые вы можете добавить к секретам, такие как *сертификат IDP* или *fingerprint*.
-
-[start=5]
++
  . <<Очистка кеша Symfony,Очистите кеш  Symfony>>
 
 
@@ -314,9 +310,9 @@ https://symfony.com/doc/current/configuration/env_var_processors.html[Symfony do
 В качестве примера изменим настройки таким образом, чтобы читать сертификат *x509cert* из файла. Следующие шаги описывают изменения, которые необходимо сделать: 
 
  . *Отредактируйте пользовательский файл настроек*
-
++
 Отредактируйте *пользовательскую* копию файла  `hslavich_onelogin_saml.yaml` для чтения сертификата *x509cert* из файла:
-
++
 [source,yaml]
 ----
 hslavich_onelogin_saml:
@@ -334,9 +330,8 @@ hslavich_onelogin_saml:
     # ...
 ----
 
-[start=2]
  . *Укажите путь до сертификата в файле `.env.local`*:
-
++
 [source,bash]
 ----
 
@@ -348,7 +343,6 @@ SAML_SP_CERT_FILE='extensions/custom/config/packages/sp_cert.crt'
 
 ----
 
-[start=3]
  . <<Очистка кеша Symfony,Очистите кеш  Symfony>>
 
 == Использование собственной аутентификации

diff --git a/content/8.x/admin/installation-guide/Downloading & Installing.ru.adoc b/content/8.x/admin/installation-guide/Downloading & Installing.ru.adoc
@@ -29,7 +29,6 @@ link:../webserver-setup-guide/[Настройка веб-сервера].
 
 == Подготовка к установке
 
-//[start=3]
  . Загрузите SuiteCRM со страницы https://suitecrm.com/download[https://suitecrm.com/download^].
  . Скопируйте загруженные файлы из архива в соответствующую папку веб-сервера и установите необходимые права (см. ниже).
 

diff --git a/content/8.x/admin/installation-guide/Languages/install-a-new-language.ru.adoc b/content/8.x/admin/installation-guide/Languages/install-a-new-language.ru.adoc
@@ -40,17 +40,15 @@ link:../update-a-language-pack/[этом] разделе.
 == Установка языкового пакета
 
  . Откройте панель администрирования.
-
++
 image:image1.png[Открытие панели администратора]
-
-[start=2]
++
  . Установите скачанный пакет в систему, как это описано в разделе 
 link:../../../../../admin/administration-panel/developer-tools/#_загрузчик_модулей[Загрузчик модулей].
  . Выйдите из системы и войдите в систему заново, предварительно выбрав необходимый язык на странице ввода логина/пароля.
-
++
 image:image3.png[Выбор языкового пакета]
-
-[start=3]
++
  . В панели администрирования при необходимости укажите русский язык в качестве языка системы по умолчанию, как это описано в разделе
 link:../../../../../admin/administration-panel/system/#_региональные_настройки[Региональные настройки].
 

diff --git a/content/8.x/admin/installation-guide/Legacy-Migration.ru.adoc b/content/8.x/admin/installation-guide/Legacy-Migration.ru.adoc
@@ -146,32 +146,30 @@ link:../../configuration/sessions-configuration[Настройка сессий^
 По умолчанию используется режим `keep`.
 
 . Режим *_KEEP_*
-
++
 * Этот режим сохранит все существующие ранее метаданные, слияние выполняться не будет.
 * Этот режим используется по умолчанию.
-
++
 В консоли выполните: 
-
++
 [source,console]
 -----
 ./bin/console suitecrm:app:upgrade-finalize -m keep
 -----
 
-[start=2]
 . Режим *_MERGE_*
-
++
 * Этот режим попытается объединить все существующие ранее метаданные с новыми метаданными. Объединение будет выполнено для каждого модуля.
 * Объединенные метаданные помещаются в папку *custom* соответствующего модуля:  `public/legacy/custom/<Module>/metadata`
 * В эту же папку добавляется файл резервной копии предыдущей версии метаданных
-
++
 В консоли выполните: 
-
++
 [source,console]
 -----
 ./bin/console suitecrm:app:upgrade-finalize -m merge
 -----
 
-[start=3]
 . Режим *_OVERRIDE_*
 
 * Этот режим заменит все текущие настройки новой версией  метаданных.
@@ -209,22 +207,19 @@ link:../../configuration/sessions-configuration[Настройка сессий^
 Есть несколько файлов журнала, которые могут предоставить дополнительную информацию:
 
 . *logs/upgrade.log*
-
++
 Файл журнала, создаваемый при обновлении SuiteCRM 8.
-
-[start=2]
++
 . *public/legacy/upgradeWizard.log*
-
++
 Специальный журнал обновления, создаётся устаревшей частью приложения. файл создается на этапе `legacy-post-upgrade`.
-
-[start=3]
++
 . *logs/<app-env-mode>/<app-env-mode>.log*
-
++
 Основной журнал системы. Путь к файлу и его имя меняются в соответствии со значением, установленным в переменной *APP_ENV*. Например, если значение установлено в `prod`, путь к файлу журнала будет `logs/prod/prod.log`
-
++
 В этом журнале скорее всего не будет содержаться много информации об обновлении.
-
-[start=4]
++
 . *public/legacy/suitecrm.log*
 
 Это основной журнал устаревшей части приложения. Он может содержать записи, связанные с обновлением, а также другую полезную информацию.

diff --git a/content/8.x/admin/installation-guide/Uninstalling.ru.adoc b/content/8.x/admin/installation-guide/Uninstalling.ru.adoc
@@ -13,14 +13,13 @@ Weight: 90
 
  .  Перейдите к папке с файлами SuiteCRM
  .  Удалите папку, пример для Linux: 
-
-[source]
++ 
+[source,console]
 rm -r SuiteCRMFolder 
-
++
 либо то же действие, но без лишних вопросов:
-
-[source] 
++
+[source,console] 
 rm -rf SuiteCRMFolder
 
-[start=3]
  .  Удалите файлы базы данных (как правило папка называется *_suitecrm_*, если только базе данных не было присвоено другое имя при установке системы). 
diff --git a/content/8.x/admin/installation-guide/Upgrading.ru.adoc b/content/8.x/admin/installation-guide/Upgrading.ru.adoc
@@ -155,42 +155,40 @@ Running: clear-symfony-cache
 По умолчанию используется режим `keep`.
 
 . Режим *_KEEP_*
-
++
 * Этот режим сохранит все существующие ранее метаданные, слияние выполняться не будет.
 * Этот режим используется по умолчанию.
-
++
 В консоли выполните: 
-
++
 [source,bash]
 -----
 ./bin/console suitecrm:app:upgrade-finalize -m keep
 -----
-
-[start=2]
++
 . Режим *_MERGE_*
-
++
 * Этот режим попытается объединить все существующие ранее метаданные с новыми метаданными. Объединение будет выполнено для каждого модуля.
 * Объединенные метаданные помещаются в папку *custom* соответствующего модуля:  `public/legacy/custom/<Module>/metadata`
 * В эту же папку добавляется файл резервной копии предыдущей версии метаданных
-
++
 В консоли выполните: 
-
++
 [source,bash]
 -----
 ./bin/console suitecrm:app:upgrade-finalize -m merge
 -----
-
-[start=3]
++
 . Режим *_OVERRIDE_*
-
++
 * Этот режим заменит все текущие настройки новой версией  метаданных.
-
++
 {{% notice warning %}}
 В результате будут удалены все текущие файлы настроек из папки `public/legacy/custom/<Module>/metadata`!
 {{% /notice %}}
-
++
 В консоли выполните: 
-
++
 [source,bash]
 -----
 ./bin/console suitecrm:app:upgrade-finalize -m override
@@ -223,27 +221,27 @@ Running: clear-symfony-cache
 . Скачайте необходимый https://suitecrm.com/https://suitecrm.com/download/[пакет ^].
 . В установленном экземпляре системы создайте  папку `<your-suitecrm-8-root-folder>/tmp/package/upgrade` и скопируйте в неё скачанный пакет. При необходимости задайте соответствующие права доступа на скопированный файл.
 . Из корневой папки SuiteCRM 8 запустите: 
-
++
 [source,bash]
 -----
 ./bin/console suitecrm:app:upgrade -t "<версия>"
 -----
-
++
 где `<версия>` - название пакета  с устанавливаемой SuiteCRM 8, например: `SuiteCRM-8.1.1`
-
++
 *Пример:* 
-
++
 [source,bash]
 -----
 ./bin/console suitecrm:app:upgrade -t SuiteCRM-8.1.1
 -----
-
++
 В результате выполнения обновления вы увидите приблизительно следующее:
-
++
 {{% notice info %}}
 В этой версии обновления сообщения, начинающиеся с `libpng warning`, можно игнорировать.
 {{% /notice %}}
-
++
 [source,bash]
 ----
 SuiteCRM Upgrade
@@ -279,7 +277,6 @@ Post Upgrade process complete
 Running: clear-symfony-cache
 ----
 
-[start=4]
 . При необходимости установите необходимые link:../downloading-installing/#_установка_прав[права доступа^].
 
 . Заново войдите в систему.
@@ -298,24 +295,21 @@ link:../../../../../8.x/admin/installation-guide/upgrading/#_4_upgrade_for_pre_r
 Есть несколько файлов журнала, которые могут предоставить дополнительную информацию:
 
 . *logs/upgrade.log*
-
++
 Файл журнала, создаваемый при обновлении SuiteCRM 8.
-
-[start=2]
++
 . *public/legacy/upgradeWizard.log*
-
++
 Специальный журнал обновления, создаётся устаревшей частью приложения. файл создается на этапе `legacy-post-upgrade`.
-
-[start=3]
++
 . *logs/<app-env-mode>/<app-env-mode>.log*
-
++
 Основной журнал системы. Путь к файлу и имя меняются в соответствии со значением, установленным в переменной *APP_ENV*. Например, если значение установлено в `prod`, путь к файлу журнала будет `logs/prod/prod.log`
-
++
 В этом журнале скорее всего не будет содержаться много информации об обновлении.
-
-[start=4]
++
 . *public/legacy/suitecrm.log*
-
++
 Это основной журнал устаревшей части приложения. Он может содержать записи, связанные с обновлением, а также другую полезную информацию.
 
 === Переменная APP_ENV 

diff --git a/content/8.x/admin/installation-guide/running-the-cli-installer.ru.adoc b/content/8.x/admin/installation-guide/running-the-cli-installer.ru.adoc
@@ -58,21 +58,20 @@ link:../downloading-installing/[Установка SuiteCRM].
 *** *"db_port"* - Порт, используемый базой данных. Указывайте этот параметр в том случае, если база данных использует нестандартный порт. По умолчанию используется стандартный порт *3306*.
 *** *"site_url"* - адрес устанавливаемого экземпляра системы (при необходимости скопируйте данные из адресной строки браузера)
 *** *"demo_data"* - добавление в БД демонстрационных данных. Допустимые значения: `yes` или `no`. 
-
++
 Пример:
-
++
 [source,bash]
 ----
 ./bin/console suitecrm:app:install -u "admin" -p "mypass" -U "root" -P "dbpass" -H "localhost" -N "suitecrm" -S "https://yourcrm.com/" -d "no"
 ----
-
++
 {{% notice tip %}}
 В примере указаны только *обязательные* аргументы. Для получения полного списка всех доступных аргументов выполните следующую команду из папки с установленной системой: `./bin/console suitecrm:app:install --help`.
 {{% /notice %}}
 
-[start=2]
  . По завершении установки ещё раз установите соответствующие права:
-
++ 
 [source,bash]
 ----
 find . -type d -not -perm 2755 -exec chmod 2755 {} \;
@@ -93,12 +92,11 @@ chmod +x bin/console
 == Заключительная проверка файлов конфигурации
 
  .  Файл `public/legacy/config.php` 
-
++
 Если виртуальный сервер не указывает на каталог  *public* в корневой папке SuiteCRM 8, то необходимо добавить */public*  к значению директивы *site_url*, например `'site_url' => 'https://your-host/crm/public',`.
-
-[start=2]
++
  . Файл `public/legacy/.htaccess`
-
++
 Если виртуальный сервер указывает на каталог *legacy*, то директива *RewriteBase* должна выглядеть как `RewriteBase /legacy`. +
 В противном случае необходимо указать путь до папки *public*.
 Например, если адрес сайта -  *\https://your-host/crm/public*, то директива *RewriteBase* должна выглядеть как `RewriteBase /crm/public/legacy`.