테마 적용 가능한 사이트 설정 출시 안내

[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
}

여기에 정의된 값은 데이터베이스에 저장되며 해당 테마와 연관됩니다. 값이 저장된 후에는, 테마 업데이트 시 about.json 파일의 theme_site_settings 변경이 현재 저장된 데이터베이스 값에 영향을 주지 않습니다. 그 사이에 관리자가 설정을 변경했는지 알 수 없기 때문입니다.

테마화 가능한 사이트 설정의 제한 사항은?

테마화 가능한 사이트 설정은 주로 UI 요소를 제어하는 데 사용되며, 값을 가져올 때 테마 ID가 필요하므로 다음과 같은 제한 사항이 적용됩니다:

• 테마화 가능한 사이트 설정은 Sidekiq 작업에서 사용할 수 없습니다.
• 테마화 가능한 사이트 설정은 마크다운 규칙에서 사용할 수 없습니다.
• 테마화 가능한 사이트 설정은 클라이언트 사이트 설정과 별도로, 테마 ID를 키로 사용하여 캐시됩니다.
• 테마화 가능한 사이트 설정은 애플리케이션 프리로더를 사용하여 클라이언트의 siteSettings 서비스에서 키를 오버라이드합니다.
• SiteSetting.client_settings_json에는 테마화 가능한 사이트 설정이 포함되지 않으며, 대신 테마 ID를 인자로 전달하여 SiteSetting.theme_site_settings_json을 호출할 수 있습니다.

일반적으로 테마 사이트 설정은 서버 측 기능이 아닌, UI의 일부만 제어하는 단순한 설정에만 사용될 것입니다.

초기 PR은 여기 있습니다: FEATURE: Themeable site settings - Pull Request #32233 - discourse/discourse - GitHub

개발자 문서는 여기 있습니다: https://meta.discourse.org/t/controlling-site-settings-with-themes/374376