Commit graph

11 commits

Author SHA1 Message Date
fiftydinar
8c0e8fa776
docs: Refactor bash module code guidelines (#175)
* docs: Refactor bash module code guidelines

* docs: Merge system & local-user config definition

Co-authored-by: Gerald Pinder <gmpinder@gmail.com>

* docs: Remove unnecessary "Bash" title

* docs: Replace "user" with "local-user" in some areas

* docs: Indicate that modules are bash-based in title

* docs: Mention bash in 1st sentence

* docs: Add `set -euo pipefail` & `set -euxo pipefail` in code rules

* docs: Make `set -euo pipefail` part clearer

* docs: Add some terms related to maintainer & user

* docs: Better separate post-install config & recipe.yml config

* docs: Add more details about System Config

* docs: Add real module path example & add example of current module which implements this

* docs: Remove 2nd path example, which can confuse users

* docs: Make yaml config more detailed

* docs: Add config location path in example

* docs: Fix "Module-maintainer" part of doc

Co-authored-by: xyny <60004820+xynydev@users.noreply.github.com>

* docs: Fix "Image-maintainer" part of doc

Co-authored-by: xyny <60004820+xynydev@users.noreply.github.com>

* docs: Fix "Local-maintainer" part of doc

Co-authored-by: xyny <60004820+xynydev@users.noreply.github.com>

* docs: Fix "error-checks" part of doc

Co-authored-by: xyny <60004820+xynydev@users.noreply.github.com>

* docs: Fix "pipefail" part of doc

Co-authored-by: xyny <60004820+xynydev@users.noreply.github.com>

* docs: Replace "Post-install" module config with "Local" term

* docs: Use "Glossary" word instead of "Terms"

* docs: Make information about proper string parsing clearer

* docs: Reword System Config

* docs: Make config info as comments, not as YAML keys

* docs: Add better explanation about how module config functions.

* docs: Make distinction between build-time & boot-time modules clearer

Boot-time is not the ideal term, but it's better than what it was before.

* docs: Fix formatting

---------

Co-authored-by: Gerald Pinder <gmpinder@gmail.com>
Co-authored-by: xyny <60004820+xynydev@users.noreply.github.com>
2024-05-04 14:03:11 +00:00
xynydev
0e4f0d45cf docs: add module doc guideline for filepaths 2024-03-02 18:48:48 +02:00
xynydev
394c3d4db5 docs: fill in guidelines for module docs 2024-03-02 18:35:25 +02:00
xynydev
5de929b89c docs: overhaul README.md 2024-02-21 16:50:06 +02:00
xynydev
c6aea9234c chore: replace URLs with ublue-os/bling 2024-02-21 16:39:34 +02:00
xynydev
0fc7ac4331 docs: update README to reflect current state of repo
- also, there should only be one h1 per page
2024-01-24 18:31:11 +02:00
Lordus Kordus
9a3ceabc68
fix: misc typos (#36)
* Fix typo in dconf-update-service.sh

* Probably a typo in rpm-ostree.sh

* Fix typo in README.md
2023-09-12 16:30:42 +00:00
xyny
3a76d99ba0
Update README.md 2023-09-10 14:35:34 +00:00
lili
4b66171439
docs: describe how to inspect image
Fixes #16
2023-06-30 00:54:44 -03:00
Tulili Blossom
4a55e01021
refactor: change container usage to be similar to ublue-os/config 2023-06-25 01:26:08 -03:00
Tulili Blossom
e845e7b5c9
chore: add sample files and README 2023-06-25 00:09:55 -03:00