Anunciando configurações de site personalizáveis

[martin (Martin Brennan)]

Este é um tópico complementar ao anúncio em Themeable site settings are now available para que os desenvolvedores estejam cientes.

@martin

Onde eles são definidos?

As configurações de site temáticas são definidas no arquivo principal config/site_settings.yml. Cada configuração de site temática tem a opção themeable: true definida.

Por enquanto, apenas duas configurações de site são temáticas – enable_welcome_banner e search_experience – mas no futuro, provavelmente tornaremos mais configurações de site temáticas.

Como os autores de temas podem controlar os valores padrão?

Os autores de temas podem definir substituições de configurações de site temáticas no arquivo about.json sob uma chave theme_site_settings como esta:

"theme_site_settings": {
  "enable_welcome_banner": false
}

Qualquer valor aqui será salvo no banco de dados e associado ao tema. Uma vez que um valor tenha sido salvo, as alterações em theme_site_settings em about.json quando um tema é atualizado não afetarão o valor do banco de dados atualmente salvo, pois não podemos saber se o administrador alterou a configuração no ínterim.

Quais são as limitações das configurações de site temáticas?

As configurações de site temáticas são realmente destinadas apenas a controlar elementos da interface do usuário e, ao recuperar seu valor, exigimos um ID de tema, portanto, estas limitações se aplicam:

• As configurações de site temáticas não podem ser usadas em trabalhos Sidekiq
• As configurações de site temáticas não podem ser usadas em regras de markdown
• As configurações de site temáticas serão armazenadas em cache separadamente das configurações de site do cliente usando o ID do tema como chave
• As configurações de site temáticas substituirão as chaves no serviço siteSettings no cliente usando o pré-carregador da aplicação
• SiteSetting.client_settings_json não incluirá configurações de site temáticas; em vez disso, você pode chamar SiteSetting.theme_site_settings_json com um ID de tema

Como regra geral, as configurações de site temáticas serão apenas para configurações simples que controlam partes da interface do usuário, nada do lado do servidor.

O PR inicial está aqui https://github.com/discourse/discourse/pull/32233

A documentação do desenvolvedor está aqui https://meta.discourse.org/t/controlling-site-settings-with-themes/374376