From 0a7002fbd0d48ab2744b09bbd20b8211cf3638df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=A4der?= Date: Sun, 15 Mar 2020 15:53:49 +0100 Subject: [PATCH] Initial Write-Up of the project principles. --- Project-Principles.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 Project-Principles.md diff --git a/Project-Principles.md b/Project-Principles.md new file mode 100644 index 0000000..66c3161 --- /dev/null +++ b/Project-Principles.md @@ -0,0 +1,40 @@ +The following are the basic principles this project is trying to achieve. +They may change of time as we learn. + +## Plug And Play + +After cloning the project for the first time, a `docker-compose up` should all be needed to get to a running Netbox instance. + +## Optimized for Local, but Production-*ready* + +The main focus of this project is to enable quick local use. +I.e. people who want to explore Netbox, who develop scripts for Netbox or develop *on* Netbox. + +But it should be possible to configure the image to be used in production. + +### A word on Security + +We should try to provide all the tools for secure operations of this Docker Image. +But our main goal is first and foremost a _Plug And Play_ experience. +Therefore not every security feature can be enabled out-of-the-box. + +## Extensibility + +We try to keep extensibility in mind. It should be possible to add additional behavior to the project. + +## Upgrade Path + +When Netbox offers and upgrade path, we should aim to do that as well. +Manual actions are good enough though, but they have to be added to the Release Notes. + +## Documentation + +The wiki should be used for user guides, FAQs and project documentation. + +## Reasoning + +We try to provide reasoning for our decisions in the project through (comments on) issues, PRs or by using the wiki. + +## Be nice + +Try to be nice in issues. This goes out to user and maintainers likewise. Always assume the best intentions. \ No newline at end of file