Git-Mirrors/qusal
1
0
Fork 0
mirror of https://github.com/ben-grande/qusal.git synced 2024-12-23 14:39:23 -05:00
Code Issues Packages Projects Releases Wiki Activity

doc: add rules for Access Control contents

Browse Source
This commit is contained in:
Ben Grande 2024-06-26 12:39:32 +02:00
parent eb3a8ab324
commit c46fa53409
No known key found for this signature in database
GPG Key ID: 00C64E14F51F9E56
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/DESIGN.md
View File

@ -70,7 +70,14 @@ 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.
@ -78,7 +85,8 @@ Every project should have a README.md with at least the following sections:
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