Skip to content

Commit

Permalink
doc: add rules for Access Control contents
Browse files Browse the repository at this point in the history
  • Loading branch information
ben-grande committed Jun 26, 2024
1 parent eb3a8ab commit c46fa53
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/DESIGN.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,15 +70,23 @@ Every project should have a README.md with at least the following sections:
- Usage; and
- Credits (if sourced).

### File naming
#### Access Control

- It must document default policy and RPC services the user can or should
edit.
- It must not document RPC services of other formulas unless the resolution of
the rule is `deny`.

### State file naming

1. Every State file `.sls` must have a Top file `.top`. This ensures that
every state can be applied with top.
2. Every project must have a `init.top`, it facilitates applying every state
by enabling a single top file.
3. State file naming must be common between the projects, it helps understand
the project as if it was any other.
4. File name must use `-` as separator, not `_`.
4. File name must use `-` as separator, not `_` (unless it is required by the
language, such as python).

### State ID

Expand Down

0 comments on commit c46fa53

Please sign in to comment.