Anuncio de configuraciones de sitio temáticas

[martin (Martin Brennan)]

Este es un tema hermano del anuncio en Themeable site settings are now available para que los desarrolladores estén al tanto.

@martin

¿Dónde se definen?

La configuración del sitio personalizable por temas se define en el archivo principal config/site_settings.yml. Cada configuración del sitio personalizable por temas tiene definida la opción themeable: true.

Por el momento, solo dos configuraciones del sitio son personalizables por temas: enable_welcome_banner y search_experience, pero en el futuro es probable que hagamos más configuraciones del sitio personalizables por temas.

¿Cómo pueden los autores de temas controlar los valores predeterminados?

Los autores de temas pueden definir anulaciones de configuración del sitio del tema en el archivo about.json bajo una clave theme_site_settings de la siguiente manera:

"theme_site_settings": {
  "enable_welcome_banner": false
}

Cualquier valor aquí se guardará en la base de datos y se asociará con el tema. Una vez que se ha guardado un valor, los cambios en theme_site_settings en el archivo about.json cuando un tema se actualiza no afectarán el valor de la base de datos guardado actualmente, ya que no podemos saber si el administrador ha cambiado la configuración en el ínterin.

¿Cuáles son las limitaciones de la configuración del sitio personalizable por temas?

La configuración del sitio personalizable por temas solo está realmente pensada para controlar elementos de la interfaz de usuario, y al recuperar su valor requerimos un ID de tema, por lo que se aplican estas limitaciones:

• La configuración del sitio personalizable por temas no se puede usar en trabajos de Sidekiq.
• La configuración del sitio personalizable por temas no se puede usar en reglas de markdown.
• La configuración del sitio personalizable por temas se almacenará en caché por separado de la configuración del sitio del cliente utilizando el ID del tema como clave.
• La configuración del sitio personalizable por temas anulará las claves en el servicio siteSettings en el cliente utilizando el precargador de la aplicación.
• SiteSetting.client_settings_json no incluirá la configuración del sitio personalizable por temas; en su lugar, puede llamar a SiteSetting.theme_site_settings_json con un ID de tema.

Como regla general, la configuración del sitio del tema solo será para configuraciones simples que controlan partes de la interfaz de usuario, nada del lado del servidor.

La PR inicial está aquí https://github.com/discourse/discourse/pull/32233

La documentación para desarrolladores está aquí https://meta.discourse.org/t/controlling-site-settings-with-themes/374376