Rename "Configuration" to "Configuration Cheat Sheet" and explain a bit

[akkoma] / docs / configuration / cheatsheet.md

diff --git a/docs/configuration/config.md b/docs/configuration/cheatsheet.md
similarity index 97%
rename from docs/configuration/config.md
rename to docs/configuration/cheatsheet.md
index 262d15bba2dbda961b09ff5408f85c6e83aaf0f0..fd936aed7e7992fad1f65904d1f0386fa7d5a63d 100644 (file)
--- a/docs/configuration/config.md
+++ b/docs/configuration/cheatsheet.md
@@ -1,7 +1,11 @@
-# Configuration
+# Configuration Cheat Sheet
+
+This is a cheat sheet for Pleroma configuration file, any setting possible to configure should be listed here.
+
+Pleroma configuration works by first importing the base config (`config/config.exs` on source installs, compiled-in on OTP releases), then overriding it by the environment config (`config/$MIX_ENV.exs` on source installs, N/A to OTP releases) and then overriding it by user config (`config/$MIX_ENV.secret.exs` on source installs, typically `/etc/pleroma/config.exs` on OTP releases).
+
+You shouldn't edit the base config directly to avoid breakages and merge conflicts, but it can be used as a reference if you don't understand how an option is supposed to be formatted, the latest version of it can be viewed [here](https://git.pleroma.social/pleroma/pleroma/blob/develop/config/config.exs).
 
-This file describe the configuration, it is recommended to edit the relevant *.secret.exs file instead of the others founds in the ``config`` directory.
-If you run Pleroma with ``MIX_ENV=prod`` the file is ``prod.secret.exs``, otherwise it is ``dev.secret.exs``.
 
 ## Pleroma.Upload
 * `uploader`: Select which `Pleroma.Uploaders` to use