Add XDG Spec informations in doc #551
Conversation
|
Fix #512 |
docs/Config.md
Outdated
|
|
||
| ### Locations: | ||
|
|
||
| - OSX: `~/Library/Application Support/jesseduffield/lazydocker/config.yml` | ||
| - Linux: `~/.config/lazydocker/config.yml` | ||
| - Windows: `C:\\Users\\<User>\\AppData\\Roaming\\jesseduffield\\lazydocker\\config.yml` (I think) | ||
| - UNIX when `XDG_CONFIG_HOME` is found: `$XDG_CONFIG_HOME/lazydocker/config.yml` |
There was a problem hiding this comment.
Readers may stop reading once they see OSX and Linux. We should say on each of those lines '(if XDF_CONFIG_HOME env variable is not set)' and we should have the unix line first.
There was a problem hiding this comment.
Alright i've changed the wording, let me know what you think
XDG Base directory extra informations
peauc
force-pushed
the
feature/issue-512-xdg-not-in-conf
branch
from
5badcf7 to
5a84446
Compare
|
I've also squashed commits on this PR |
| - UNIX(if `XDG_CONFIG_HOME` environment variable is found): `$XDG_CONFIG_HOME/lazydocker/config.yml` | ||
| - OSX(if `XDG_CONFIG_HOME` environment variable is **not** found): `~/Library/Application Support/jesseduffield/lazydocker/config.yml` | ||
| - Linux(if `XDG_CONFIG_HOME` environment variable is **not** found): `~/.config/lazydocker/config.yml` |
There was a problem hiding this comment.
Imo, this should take place as a note. after. even if readers "stop reading", instead of bloating.
There was a problem hiding this comment.
I agree: this should just say that if the XDG_CONFIG_HOME env var is set, we use $XDG_CONFIG_HOME/lazydocker/config.yml, then the rest can be stated as fallbacks without being as verbose
|
|
||
| ### Locations: | ||
|
|
||
| - OSX: `~/Library/Application Support/jesseduffield/lazydocker/config.yml` | ||
| - Linux: `~/.config/lazydocker/config.yml` | ||
| Lazydocker follows the [XDG base directory specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) meaning that the config will be placed in `XDG_CONFIG_HOME` if the variable is found. |
There was a problem hiding this comment.
maybe rephrase?
Lazydocker adheres to the XDG Base Directory Specification, placing its configuration in XDG_CONFIG_HOME if the variable is set.
Add the fact that lazydocker uses XDG Spec for the config file