Skip to content

Commit 7fb1754

Browse files
committed
Clean public release wording
1 parent 4e2371f commit 7fb1754

21 files changed

Lines changed: 106 additions & 108 deletions

README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ Operational definitions are external to the Python sources:
1616
- secrets YAML
1717
- optional external plugins
1818

19-
2019
## Documentation site
2120

2221
The GitHub Pages site is the full public manual, not just a README mirror. It
@@ -45,7 +44,6 @@ A step opens one fresh SSH connection per target and reuses it for all its
4544
substeps. Runtime context is not kept in a shell session: values are passed
4645
through the Automax context, registered outputs and state store.
4746

48-
4947
## YAML flow control
5048

5149
Job YAML supports engine-level flow-control substeps in addition to plugin
@@ -202,7 +200,6 @@ automax run --job job.yaml --inventory inventory.yaml --from task.install
202200
automax run --job job.yaml --inventory inventory.yaml --from task.install:step.packages
203201
```
204202

205-
206203
## Job inspection and recovery
207204

208205
Before running or resuming a job, operators can generate one masked review

docs/TECHNICAL_DESIGN.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ shell. Plugins that need step-local state can use the `ExecutionContext.step_sta
2727
mapping internally. Job authors should pass explicit plugin parameters such as
2828
`cwd` instead of relying on implicit cross-substep shell state.
2929

30-
3130
Flow-control nodes are engine-level constructs, not plugins. They let job authors
3231
branch, switch, retry nested blocks, loop, group blocks, set values, echo messages, assert conditions, pause explicitly, record no-op branches, fail deliberately, recover with
3332
`try`/`rescue`/`always`, and use `break`/`continue` in loops while keeping nested

docs/concepts/execution-model.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ A substep calls one plugin:
4545
sudo: true
4646
```
4747
48-
4948
Flow-control substeps do not call plugins directly. `if`, list-style `if`, `switch`, `retry`, `for`,
5049
`block`, `set` / `let`, `echo`, `assert`, `sleep`, `noop`, `fail`, `try` / `rescue` / `always`, `break` and
5150
`continue` are interpreted by the engine and then execute normal nested substeps

docs/guides/creating-plugins.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,6 @@ the build when metadata, preview or dry-run quality gates regress. External
7474
plugins loaded with `--plugin-path` are described and audited through the same
7575
registry contract.
7676

77-
7877
## External plugin SDK workflow
7978

8079
Use the SDK commands to create a checked plugin source file before loading it in

docs/guides/kernel-tuning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ Automax manages Linux runtime kernel parameters through `system.kernel.sysctl.*`
2828
sudo: true
2929
```
3030
31-
Use `system.kernel.sysctl.get` for checks, `system.kernel.sysctl.reload` to reload persisted files, and `system.kernel.module.unload` / `system.kernel.module.persist` for module lifecycle management.
31+
Use `system.kernel.sysctl.get` for checks, `system.kernel.sysctl.reload` to reload persisted files, and `system.kernel.module.unload` / `system.kernel.module.persist` for module management.

docs/guides/templating.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,6 @@ Registered outputs can be reused later in the same run:
6969

7070
The full result then becomes available as `outputs.app_stat`.
7171

72-
7372
## Flow-control values
7473

7574
`if`, branch `when` conditions, and `for` values use the same Jinja context as
@@ -93,7 +92,6 @@ variable and through `item`. It also exposes `loop.index`, `loop.index0`,
9392
command: "echo {{ loop.index }} {{ member }}"
9493
```
9594

96-
9795
## Flow values and messages
9896

9997
`set` and `let` evaluate native Jinja expressions and store values for later

docs/plugins/archive.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,6 @@ Extracts a zip archive on the remote target.
9797
creates: /opt/package/bin/app
9898
```
9999

100-
101100
Archive plugins do not add `sudo` themselves. Run them as a user with the required remote permissions, or wrap exceptional privileged archive operations with an explicit `command.remote.run` until privileged archive support is added.
102101

103102
## Safe extraction

docs/plugins/commands.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ Runs a command on the current target through the step-scoped SSH connection.
4040
`command.remote.run` is intentionally raw. For filesystem, package, service, archive,
4141
transfer, database or HTTP operations, prefer the dedicated plugin names.
4242

43-
4443
`command.local.run` uses the controller shell for string commands, matching Python `subprocess.run(..., shell=True)`. Keep it for trusted operator-authored jobs and prefer list-style commands in future extensions when shell parsing is not desired.
4544

4645
`command.remote.run` accepts `cwd`, `timeout`, `stdin`, `pty`, `encoding`, `success_rc` and `changed`. Use explicit `cwd` on the substep that needs a working directory instead of relying on implicit shell state.

docs/plugins/database.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,6 @@ register the canonical plugin in `build_builtin_registry()` or load it through a
131131
external plugin path. The shared base already handles statement validation,
132132
output shaping and common result metadata.
133133

134-
135134
## Database health checks
136135

137136
`database.sqlite.check` is a read-only controller-side health check plugin for the existing

docs/plugins/firewall.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ inspect or archive the active nftables ruleset. Use `network.firewall.iptables.l
4141
`network.firewall.iptables.policy` and `network.firewall.iptables.chain` to inspect iptables/ip6tables state before
4242
and after runtime rule changes.
4343

44-
## Lifecycle safeguards
44+
## Change safeguards
4545

4646
`network.firewall.firewalld.*` operations expose explicit runtime/permanent selection,
4747
`query_only` readback and `reload_mode`. `network.firewall.iptables.rule` supports ordered

0 commit comments

Comments
 (0)