particle-os/particle-os-modules
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: improve examples, remove docs superseded by typespec docstrings (#279)

Browse source 
* chore(bling): uncomment example options

* refactor(brew): remove duplicate "configuration options" setting in README, improve TSP docs

* fix(chezmoi): make example an example and not a doc of the configuration options

* chore(rpm-ostree): remove fake example

examples should be runnable

* fix(rpm-ostree): add replacing packages to typespec schema

* fix(rpm-ostree): actually install the packages the repos are added for

* feat(rpm-ostree): showcase installing from URL and using optfix in example

* fix(rpm-ostree): add optfix to typespec

* fix(systemd): real-world example instead of configuration docs duplicate
This commit is contained in:
xyny 2024-07-16 17:09:00 +00:00 • committed by GitHub
parent f91f2abc90
commit 46b1070110
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 48 additions and 67 deletions
Download patch file Download diff file Expand all files Collapse all files

18
modules/brew/module.yml
View file

@ -4,19 +4,5 @@ readme: https://raw.githubusercontent.com/blue-build/modules/main/modules/brew/R
typespec: https://raw.githubusercontent.com/blue-build/modules/main/modules/brew/brew.tsp
example: |
type: brew
# Auto-update Brew binary
auto-update: true # Optional - Default: true - Expects type: boolean
# Interval between Brew updates
update-interval: '6h' # Optional - Default: '6h' - Expects type: string
# Time delay after boot before first Brew update
update-wait-after-boot: '10min' # Optional - Default: '10min' - Expects type: string
# Auto-upgrade Brew packages
auto-upgrade: true # Optional - Default: true - Expects type: boolean
# Interval between Brew package upgrades
upgrade-interval: '8h' # Optional - Default: '8h' - Expects type: string
# Time delay after boot before first Brew upgrade
upgrade-wait-after-boot: '30min' # Optional - Default: '30min' - Expects type: string
# Apply nofile limits for Brew installations
nofile-limits: false # Optional - Default: false - Expects type: boolean
# Control Brew analytics
brew-analytics: true # Optional - Default: true - Expects type: boolean
nofile-limits: true # increase nofile limits
brew-analytics: false # disable telemetry