mirror of
https://github.com/chenasraf/sofmani.git
synced 2026-05-17 17:28:04 +00:00
docs: update docs
This commit is contained in:
@@ -145,7 +145,8 @@ For more information, see [Configuration Reference](./docs/configuration-referen
|
||||
|
||||
Here is a quick breakdown of all configuration options.
|
||||
|
||||
For a full breakdown with all the supported options, see [the docs](./docs/installer-types.md).
|
||||
For a full breakdown with all the supported options, see
|
||||
[the docs](./docs/installer-configuration.md).
|
||||
|
||||
### Global Options
|
||||
|
||||
@@ -184,7 +185,7 @@ actions. Steps can be of **several types**, such as `brew`, `rsync`, `shell`, an
|
||||
|
||||
### Supported `type` of Installers
|
||||
|
||||
For a full list with all the supported options, see [the docs](./docs/installer-types.md).
|
||||
For a full list with all the supported options, see [the docs](./docs/installer-configuration.md).
|
||||
|
||||
- **`shell`**
|
||||
|
||||
|
||||
@@ -7,5 +7,5 @@ For a general overview, see the [README](/README.md).
|
||||
- [Getting Started](./getting-started.md)
|
||||
- [Command Line Interface (CLI)](./command-line-interface.md)
|
||||
- [Configuration Reference](./configuration-reference.md)
|
||||
- [Installer Types](./installer-types.md)
|
||||
- [Installer Configuration](./installer-configuration.md)
|
||||
- [Recipes](./recipes) - Installer groups you can use immediately as remote manifests
|
||||
|
||||
@@ -37,7 +37,7 @@ The following filter types are available:
|
||||
|
||||
Each of the above filters can be negated by prefixing with `!`. For example, to exclude installers
|
||||
containing the tag `"system"`, use `-f "!tag:system"`. See more information about tags in the
|
||||
documentation for (Installer Types)[./installer-types.md#fields].
|
||||
documentation for (Installer Configuration)[./installer-configuration.md#fields].
|
||||
|
||||
If there are no filters in the command flags, then all the installers will run.
|
||||
|
||||
|
||||
@@ -8,8 +8,8 @@ Here is a breakdown of all configuration options:
|
||||
|
||||
- Installation steps to execute.
|
||||
|
||||
- See [Installer Types](./installer-types.md) for supported types and options that you can
|
||||
provide.
|
||||
- See [Installer Configuration](./installer-configuration.md) for supported types and options that
|
||||
you can provide.
|
||||
|
||||
- **`debug`** (Boolean)
|
||||
|
||||
@@ -30,8 +30,8 @@ Here is a breakdown of all configuration options:
|
||||
|
||||
A mapping between each type (key) and their default options (value).
|
||||
|
||||
- See [Installer Types](./installer-types.md) for supported types and options that you can
|
||||
override.
|
||||
- See [Installer Configuration](./installer-configuration.md) for supported types and options
|
||||
that you can override.
|
||||
|
||||
- **`env`** (Object)
|
||||
- Environment variables that will be set for the context of the installer.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Installer Types
|
||||
# Installer Configuration
|
||||
|
||||
The `install` field describes the steps to execute. Each step represents an action or group of
|
||||
actions. Steps can be of **several types**, such as `brew`, `rsync`, `shell`, and more.
|
||||
Reference in New Issue
Block a user