Skip to content

Commit 052b17d

Browse files
committed
Slight improvements
1 parent 7516e5d commit 052b17d

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

PRINCIPALS.md

+14-7
Original file line numberDiff line numberDiff line change
@@ -21,26 +21,27 @@ The goal of the _NetBox Docker_ project is to provide a container to run the bas
2121
The container should feel like a native container -- as if it were provided by NetBox itself:
2222

2323
- Configuration via environment variables where feasible.
24+
- Except: Whenever a `dict` is required as value of a configuration setting,
25+
then it must not be provided through an environment variable.
2426
- Configuration of secrets via secret files.
2527
- Log output to standard out (STDOUT/&1) / standard error (STDERR/&2).
2628
- Volumes for data and cache directories.
29+
- Otherwise no mounts shall be necessary.
2730
- Runs a non-root user by default.
2831
- One process / role for each instance.
2932

30-
There is one exception for the configuration:
31-
Whenever a `dict` is required as value of a configuration setting, then it must not be provided through an environment variable.
32-
3333
The container generally does not provide more features than the basic NetBox project itself provides.
34-
It may provide additional Python dependencies than the upstream project, so that all features of NetBox can be used in the container.
35-
It may provide helpers, so that the container feels and behaves like a native container.
34+
It may provide additional Python dependencies than the upstream project,
35+
so that all configurable features of NetBox can be used in the container without further modification.
36+
The container may provide helpers, so that it feels and behaves like a native container.
3637

37-
The container does not come with pre-bundled plugins.
38+
The container does not bundle any community plugins.
3839

3940
## Maintenance Principals
4041

4142
The main goals of maintainig _NetBox Docker_ are:
4243

43-
- Keeping the project on a high quality level.
44+
- Keeping the project at a high quality level.
4445
- Keeping the maintenance effort minimal.
4546
- Coordinating development efforts.
4647

@@ -60,3 +61,9 @@ We welcome contributions, as long as they are in line with the principals above.
6061

6162
The maintainers of NetBox Docker are not the support team.
6263
The community is expected to help each other out.
64+
65+
Always remember:
66+
Behind every screen (or screen-reader) on the other end is a fellow human.
67+
Be nice and respectful, thankful for help,
68+
and value ideas and contributions,
69+
even when they don't fit the goals.

0 commit comments

Comments
 (0)