Add reworked configuration docs. #245
Conversation
docs/configuration/description.md
Outdated
| Files are placed in the `.mainframer` directory. | ||
| The final configuration is the combination of files placed in: | ||
|
|
||
| * `${HOME}/.mainframer` — the global configuration; |
There was a problem hiding this comment.
btw, that I would probably like to change to ~/.config/mainframer
A lot of other tools store configs there (example from my machine):
tree -L 1 ~/.config
/Users/user/.config
├── alacritty
├── gcloud
├── gtk-2.0
├── htop
├── kitty
├── nvim
└── thefuckCan't find it being described as some standard other than by XDG https://unix.stackexchange.com/questions/68721/where-should-user-configuration-files-go but a lot of tools seem to use it now
There was a problem hiding this comment.
Sounds good. Yes, it is XDG-only, but I don’t mind a semi-clean home directory on macOS.
There was a problem hiding this comment.
My example is from macOS just in case :)
docs/configuration/description.md
Outdated
| * `${HOME}/.mainframer` — the global configuration; | ||
| * `.mainframer` — the project configuration. | ||
|
|
||
| It is posssible to share the configuration using the global one |
There was a problem hiding this comment.
Maybe reword?
"It is possible to declare common configuration using the global one and fine-tune it using the project one"
docs/configuration/description.md
Outdated
|
|
||
| Name | Optional | Value | Default | Description | ||
| -------------------|----------|---------|---------|------------------ | ||
| `remote.name` | No | `string`| — | Remote machine name from SSH config. |
There was a problem hiding this comment.
"Hostname/IP or remote machine name from $HOME/.ssh/config."
docs/configuration/description.md
Outdated
| compression: {level} | ||
| ``` | ||
|
|
||
| Name | Optional | Value | Default | Description |
There was a problem hiding this comment.
Usually it's "Required" instead of "Optional" :)
| > `1` gives best speed, `9` gives best compression, `0` gives no compression at all | ||
| > (the input data is simply copied a block at a time). | ||
|
|
||
| ## `.mainframer/ignore.yml` |
There was a problem hiding this comment.
This section misses description
There was a problem hiding this comment.
Files are described in the .mainframer section above.
There was a problem hiding this comment.
Yeah, I guess I just wanted to see description there, ok let's go without it for now then
|
@artem-zinnatullin, updated. |
docs/configuration/description.md
Outdated
| @@ -0,0 +1,69 @@ | |||
| Files are placed in the `.mainframer` directory. | |||
There was a problem hiding this comment.
This sentence is overlapped with next paragraph and also is incorrect in case of ${HOME}/.config/mainframer
| Name | Required | Value | Default | Description | ||
| -------------------|----------|---------|---------|------------------ | ||
| `remote.name` | Yes | `string`| — | Remote machine name from SSH config or hostname / IP address. | ||
| `push.compression` | No | `0..9` | `0` | Compression level used to copy files from local machine to remote one. |
| -------------------|----------|---------|---------|------------------ | ||
| `remote.name` | Yes | `string`| — | Remote machine name from SSH config or hostname / IP address. | ||
| `push.compression` | No | `0..9` | `0` | Compression level used to copy files from local machine to remote one. | ||
| `pull.compression` | No | `0..9` | `0` | Compression level used to copy files from remote machine to local one. |
There was a problem hiding this comment.
Are these our values? Do you have a reference otherwise? I’ve found an outdated email. The source code says otherwise — seems to be -1 (Z_DEFAULT_COMPRESSION value).
There was a problem hiding this comment.
MF 2.x uses 1 by default for both cases.
There was a problem hiding this comment.
It's in 3.x PR #239, idea is that usually you push text files which are very compressible and pull binaries which are barely compressible, thus push 3 and pull 1
There was a problem hiding this comment.
We can update this doc in #239, going to merge your PR now
No description provided.