docs: enhacements to module documentation (#54)

* docs: chore: rn ":" from "Example configuration"

* docs: correct title casing for fonts module title

* docs: document OS_VERSION in example,...
non-copr example for rpmrepos

* docs: remove bling fonts option from bling example

* docs: start yafti README the same way as others
"The yafti module..."
This commit is contained in:
xyny 2023-10-01 18:41:01 +03:00 committed by GitHub
parent 268e02f9ed
commit 4e79916835
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 9 additions and 8 deletions

View file

@ -4,7 +4,7 @@ The `bling` module allows you to easily declare which general parts of `ublue-os
The bling to pull in is declared under `install:`, and the code for installing them is all in simple named scripts under the `installers/` directory. The basic code for the `bling` module is very similar to the code of the `script` module.
## Example configuration:
## Example configuration
```yaml
type: bling # configure what to pull in from ublue-os/bling

View file

@ -5,7 +5,7 @@ The `files` module simplifies the process of copying files to the image during t
> **Warning**
> If you want to place anything in `/etc` of the final image, you MUST place them in `/usr/etc` in your repo, so that they're written to `/usr/etc` on the final system. That is the proper directory for "system" configuration templates on immutable Fedora distros, whereas the normal `/etc` is meant for manual overrides and editing by the machine's admin AFTER installation! See issue https://github.com/ublue-os/startingpoint/issues/28.
## Example Configuration:
## Example Configuration
```yaml
type: files

View file

@ -1,4 +1,4 @@
# `fonts` module for startingpoint
# `fonts` Module for Startingpoint
The `fonts` module can be used to install [nerd-fonts](https://www.nerdfonts.com/) or [google-fonts](https://fonts.google.com/). This module will always download the latest version and properly configure fonts.

View file

@ -8,12 +8,13 @@ Then the module installs the packages declared under `install:` using `rpm-ostre
Additionally, the `rpm-ostree` module supports a temporary (waiting for `rpm-ostree` issue [#233](https://github.com/coreos/rpm-ostree/issues/233)) fix for packages that install into `/opt/`. Installation for packages that install into folder names declared under `optfix:` are fixed using some symlinks.
## Example Configuration:
## Example Configuration
```yaml
type: rpm-ostree
repos:
- https://copr.fedorainfracloud.org/coprs/atim/starship/repo/fedora-%OS_VERSION%/atim-starship-fedora-%OS_VERSION%.repo
- https://copr.fedorainfracloud.org/coprs/atim/starship/repo/fedora-%OS_VERSION%/atim-starship-fedora-%OS_VERSION%.repo # when including COPR repos, use the %OS_VERSION% magic string
- https://pkgs.tailscale.com/stable/fedora/tailscale.repo
install:
- python3-pip
- libadwaita

View file

@ -2,7 +2,7 @@
The `systemd` module streamlines the management of systemd units during image building. Units are divided into `system` and `user` categories, with `system` units managed directly using `systemctl` and `user` units using `systemctl --user`. You can specify which units to enable or disable under each category.
## Example Configuration:
## Example Configuration
```yaml
type: systemd

View file

@ -1,12 +1,12 @@
# [`yafti`](https://github.com/ublue-os/yafti) Module for Startingpoint
If included, the `yafti` module will install `yafti` and set it up to run on first boot. Also `yafti`'s dependencies, `python3-pip` and `libadwaita` are installed
The `yafti` module can be used to install `yafti` and set it up to run on first boot. Also `yafti`'s dependencies, `python3-pip` and `libadwaita` are installed.
Optionally, a list of Flatpak names and IDs can be included under `custom-flatpaks:`. These will be enabled by default under their own section on the Flatpak installation screen of `yafti`.
The main `yafti` configuration file, `yafti.yml`, is in `/usr/share/ublue-os/firstboot/yafti.yml` and can be edited for a more custom first-boot experience.
## Example configuration:
## Example configuration
```yaml
type: yafti