From 1ae8ea2611d357ac11626d44e79c30a7901d4dc2 Mon Sep 17 00:00:00 2001 From: arushxsingh Date: Tue, 6 Jan 2026 20:04:02 +0530 Subject: [PATCH] Add locale plugin demo README --- .vscode/settings.json | 3 +++ demos/locale/README.md | 58 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 61 insertions(+) create mode 100644 .vscode/settings.json create mode 100644 demos/locale/README.md diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000000..7b016a89fb --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "java.compile.nullAnalysis.mode": "automatic" +} \ No newline at end of file diff --git a/demos/locale/README.md b/demos/locale/README.md new file mode 100644 index 0000000000..b339291f9c --- /dev/null +++ b/demos/locale/README.md @@ -0,0 +1,58 @@ +# Configure Locale plugin + +Basic configuration of the [Locale plugin](https://plugins.jenkins.io/locale) + +The Locale plugin allows administrators to control the language settings of the Jenkins user interface, overriding browser preferences and setting a default language for all users. + +## sample configuration + +```yaml +appearance: + locale: + systemLocale: en + ignoreAcceptLanguage: true + allowUserPreferences: false +``` + +### Configuration options + +- `systemLocale`: The default language code to use for the Jenkins UI (e.g., `en`, `fr`, `de`, `ja`, `zh_CN`, `de_AT`) +- `ignoreAcceptLanguage`: If `true`, ignores browser language preferences and forces all users to use the system locale +- `allowUserPreferences`: If `true`, allows users to set their own language preferences. If `false`, users must use the system locale + +### Example: Force English for all users + +This configuration forces all users to use English, ignoring browser preferences and not allowing user preferences: + +```yaml +appearance: + locale: + systemLocale: en + ignoreAcceptLanguage: true + allowUserPreferences: false +``` + +### Example: Default to French but allow user preferences + +This configuration sets French as the default but allows users to override it: + +```yaml +appearance: + locale: + systemLocale: fr + ignoreAcceptLanguage: false + allowUserPreferences: true +``` + +### Example: Default to German (Austria) with browser preference fallback + +This configuration sets Austrian German as default but respects browser preferences if not forced: + +```yaml +appearance: + locale: + systemLocale: de_AT + ignoreAcceptLanguage: false + allowUserPreferences: true +``` +