Объявление о настраиваемых настройках сайта

[martin (Martin Brennan)]

Это сопутствующая тема к объявлению на Themeable site settings are now available, чтобы разработчики были в курсе.

@martin

Где они определены?

Настраиваемые настройки сайта определены в основном файле config/site_settings.yml. Для каждой настраиваемой настройки сайта указан параметр themeable: true.

На данный момент настраиваемыми являются только две настройки сайта — enable_welcome_banner и search_experience, но в будущем мы, скорее всего, сделаем настраиваемыми больше настроек.

Как авторы тем могут управлять значениями по умолчанию?

Авторы тем могут определить переопределения настроек темы в файле about.json под ключом theme_site_settings следующим образом:

"theme_site_settings": {
  "enable_welcome_banner": false
}

Любое значение здесь будет сохранено в базе данных и связано с темой. После сохранения значения изменения в theme_site_settings в файле about.json при обновлении темы не повлияют на текущее сохраненное значение в базе данных, поскольку мы не можем знать, изменил ли администратор настройку в этот промежуток времени.

Каковы ограничения настраиваемых настроек сайта?

Настраиваемые настройки сайта предназначены в первую очередь для управления элементами пользовательского интерфейса, и при получении их значения требуется идентификатор темы, поэтому применяются следующие ограничения:

• Настраиваемые настройки сайта нельзя использовать в задачах Sidekiq
• Настраиваемые настройки сайта нельзя использовать в правилах Markdown
• Настраиваемые настройки сайта будут кэшироваться отдельно от клиентских настроек сайта с использованием идентификатора темы в качестве ключа
• Настраиваемые настройки сайта будут переопределять ключи в сервисе siteSettings на клиенте с помощью предзагрузчика приложения
• SiteSetting.client_settings_json не будет включать настраиваемые настройки сайта; вместо этого вы можете вызвать SiteSetting.theme_site_settings_json с идентификатором темы

Как общее правило, настройки темы будут предназначены только для простых параметров, управляющих частями пользовательского интерфейса, а не для серверной логики.

Первый PR доступен здесь: FEATURE: Themeable site settings by martin-brennan · Pull Request #32233 · discourse/discourse · GitHub

Документация для разработчиков доступна здесь: https://meta.discourse.org/t/controlling-site-settings-with-themes/374376