CS-11412: Avoid special characters in config (#2203)

* configuration.md: About avoiding special characters in config files * multisite_configuration.md: About avoiding special characters in var_dir * common_issues.md: About avoiding special characters in var_dir --------- Co-authored-by: Adrien Dupuis <[email protected]> Co-authored-by: Tomasz Dąbrowski <[email protected]>
ibexa · Dec 1, 2023 · 69c101f · 69c101f
1 parent 9f7d527
commit 69c101f
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/docs/administration/configuration/configuration.md b/docs/administration/configuration/configuration.md
@@ -36,6 +36,14 @@ These files contain additional settings and point to the general (not environmen
 
     Read more about [how configuration is handled in Symfony]([[= symfony_doc =]]/best_practices/configuration.html).
 
+!!! caution "Special characters"
+
+    Avoid using special characters in your configuration files. More specifically, don't use Unicode characters from the ["Other" (`C`) categories](https://en.wikipedia.org/wiki/Unicode#General_Category_property), such as control or format characters.
+
+    Make sure your IDE displays them.
+
+    Be careful when copy-pasting text from a word processing software or a PDF, because it might contain hidden characters like the [soft hyphen](https://en.wikipedia.org/wiki/Soft_hyphen).
+
 ### Configuration handling
 
 !!! note

diff --git a/docs/multisite/multisite_configuration.md b/docs/multisite/multisite_configuration.md
@@ -49,6 +49,7 @@ and ideally also separate Varnish/Fastly configuration.
 !!! caution
 
     Different SiteAccesses can only have different `var_dir` if they also have different repositories.
+    Make sure there are no special or Unicode characters in your `var_dir` values.
 
 ### Default SiteAccess
 

diff --git a/docs/update_and_migration/migrate_to_ibexa_dxp/common_issues.md b/docs/update_and_migration/migrate_to_ibexa_dxp/common_issues.md
@@ -38,6 +38,10 @@ In that case, run the `ezplatform:images:normalize-path` command to normalize th
 php bin/console ezplatform:images:normalize-path
 ```
 
+!!! note "Special characters"
+
+    If a corrupted path is detected, check the `var_dir` configuration for any special or Unicode characters.
+
 ## Unknown relation type 0
 
 "Unknown relation type 0." error occurs only when using REST API. The issue does not occur