docs: Improve documentation of relocatable schemas (#177)

* docs(bling): Add documentation about dconf-update-service

* docs(gschema-overrides): Improve relocatable schema info and include better example

* chore: add more details to dconf desc

* chore: minor gschema relocatable rewording

---------

Co-authored-by: xyny <60004820+xynydev@users.noreply.github.com>
This commit is contained in:
jonah 2024-03-26 03:12:01 -04:00 committed by GitHub
parent 9fbffaea27
commit b866a27cf1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 18 additions and 13 deletions

View file

@ -10,7 +10,7 @@ The bling to pull in is declared under `install:`, and the code for installing t
The `flatpaksync` submodule can be used to synchronize a list of user Flatpaks with a git repository.
Once the submodule is activated, you should create the file `$HOME/.config/flatpaksync/env` that sets the `GIT_REPO` variable to the git URL of your repository. This repository can be empty, or a previous flatpaksync installation. The repository is automatically cloned into `/tmp/sync` for the synchronization.
Once the submodule is activated, you should create the file `$HOME/.config/flatpaksync/env` that sets the `GIT_REPO` variable to the git URL of your repository. This repository can be empty, or a previous flatpaksync installation. The repository is automatically cloned into `/tmp/sync` for the synchronization.
```bash
# ~/.config/flatpaksync/env
@ -21,4 +21,10 @@ To initialize your Flatpaks from flatpaksync, simply run the `flatpakcheckout` c
**It is important to note that this submodule will NOT enable Flathub. If your applications come from there, you will need to enable Flathub before running it.**
If you have configured the repository in the `$HOME/.config/flatpaksync/env` file but already have the Flatpaks installed, simply create the `$HOME/.config/flatpaks.user.installed` file to inform the script that the installation is done and start the synchronization.
If you have configured the repository in the `$HOME/.config/flatpaksync/env` file but already have the Flatpaks installed, simply create the `$HOME/.config/flatpaks.user.installed` file to inform the script that the installation is done and start the synchronization.
### `dconf-update-service`
The `dconf-update-service` submodule creates a systemd unit to automatically update changes you make to [dconf](https://wiki.gnome.org/Projects/dconf) in your custom image. For an example of a dconf keyfile, see the [dconf custom defaults documentation](https://help.gnome.org/admin/system-admin-guide/stable/dconf-custom-defaults.html.en).
**Unlike the `gschema-overrides` module, dconf keyfiles are not checked at compile time**