Docs/devcontainer (#4787)

* Added empty problemMatchers to prevent vscode from asking

* Added first draft for devcontainer docs

* Add 3rd space to tips

* Fix wording

* Add 4rd space to tips

* Refphased intro text

* Fixed spelling mistakes and added note

* Added dynamic variables for devcontainer

* Added missing containerWorkspaceFolder vars other devcontainer files

Co-authored-by: Oliver <oliver.henry.walters@gmail.com>

* Added note for inventree core intelicense for plugin devs

* Added where is dev data stored question to faq

* Update docs/docs/start/devcontainer.md

* update toc

---------

Co-authored-by: Oliver <oliver.henry.walters@gmail.com>
Co-authored-by: Matthias Mair <code@mjmair.com>

.devcontainer/Dockerfile

@@ -4,6 +4,8 @@
 ARG VARIANT="3.10-bullseye"
 FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}
 
+ARG WORKSPACE="/workspaces/InvenTree"
+
 # [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
 ARG NODE_VERSION="none"
 RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
@@ -42,6 +44,6 @@ RUN pip install --disable-pip-version-check -U -r base_requirements.txt
 # preserve command history between container starts
 # Ref: https://code.visualstudio.com/remote/advancedcontainers/persist-bash-history
 # Folder will be created in 'postCreateCommand' in devcontainer.json as it's not preserved due to the bind mount
-RUN echo "export PROMPT_COMMAND='history -a' && export HISTFILE=/workspaces/InvenTree/dev/commandhistory/.bash_history" >> "/home/vscode/.bashrc"
+RUN echo "export PROMPT_COMMAND='history -a' && export HISTFILE=${WORKSPACE}/dev/commandhistory/.bash_history" >> "/home/vscode/.bashrc"
 
-WORKDIR /workspaces/InvenTree
+WORKDIR ${WORKSPACE}

.devcontainer/devcontainer.json

@@ -11,7 +11,8 @@
       // Use -bullseye variants on local on arm64/Apple Silicon.
       "VARIANT": "3.10-bullseye",
       // Options
-      "NODE_VERSION": "lts/*"
+      "NODE_VERSION": "lts/*",
+      "WORKSPACE": "${containerWorkspaceFolder}"
     }
   },
 
@@ -21,7 +22,7 @@
     "vscode": {
       // Set *default* container specific settings.json values on container create.
       "settings": {
-        "python.defaultInterpreterPath": "/workspaces/InvenTree/dev/venv/bin/python",
+        "python.defaultInterpreterPath": "${containerWorkspaceFolder}/dev/venv/bin/python",
         "python.linting.enabled": true,
         "python.linting.pylintEnabled": false,
         "python.linting.flake8Enabled": true,
@@ -55,7 +56,7 @@
   },
 
   // Use 'postCreateCommand' to run commands after the container is created.
-  "postCreateCommand": "./.devcontainer/postCreateCommand.sh",
+  "postCreateCommand": "./.devcontainer/postCreateCommand.sh ${containerWorkspaceFolder}",
 
   // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
   "remoteUser": "vscode",
@@ -69,22 +70,22 @@
     "INVENTREE_DEBUG": "True",
     "INVENTREE_DEBUG_LEVEL": "INFO",
     "INVENTREE_DB_ENGINE": "sqlite3",
-    "INVENTREE_DB_NAME": "/workspaces/InvenTree/dev/database.sqlite3",
-    "INVENTREE_MEDIA_ROOT": "/workspaces/InvenTree/dev/media",
-    "INVENTREE_STATIC_ROOT": "/workspaces/InvenTree/dev/static",
-    "INVENTREE_BACKUP_DIR": "/workspaces/InvenTree/dev/backup",
-    "INVENTREE_CONFIG_FILE": "/workspaces/InvenTree/dev/config.yaml",
-    "INVENTREE_SECRET_KEY_FILE": "/workspaces/InvenTree/dev/secret_key.txt",
+    "INVENTREE_DB_NAME": "${containerWorkspaceFolder}/dev/database.sqlite3",
+    "INVENTREE_MEDIA_ROOT": "${containerWorkspaceFolder}/dev/media",
+    "INVENTREE_STATIC_ROOT": "${containerWorkspaceFolder}/dev/static",
+    "INVENTREE_BACKUP_DIR": "${containerWorkspaceFolder}/dev/backup",
+    "INVENTREE_CONFIG_FILE": "${containerWorkspaceFolder}/dev/config.yaml",
+    "INVENTREE_SECRET_KEY_FILE": "${containerWorkspaceFolder}/dev/secret_key.txt",
     "INVENTREE_PLUGINS_ENABLED": "True",
-    "INVENTREE_PLUGIN_DIR": "/workspaces/InvenTree/dev/plugins",
-    "INVENTREE_PLUGIN_FILE": "/workspaces/InvenTree/dev/plugins.txt",
+    "INVENTREE_PLUGIN_DIR": "${containerWorkspaceFolder}/dev/plugins",
+    "INVENTREE_PLUGIN_FILE": "${containerWorkspaceFolder}/dev/plugins.txt",
 
     // Python config
     "PIP_USER": "no",
 
     // used to load the venv into the PATH and activate it
     // Ref: https://stackoverflow.com/a/56286534
-    "VIRTUAL_ENV": "/workspaces/InvenTree/dev/venv",
-    "PATH": "/workspaces/InvenTree/dev/venv/bin:${containerEnv:PATH}"
+    "VIRTUAL_ENV": "${containerWorkspaceFolder}/dev/venv",
+    "PATH": "${containerWorkspaceFolder}/dev/venv/bin:${containerEnv:PATH}"
   }
 }

.devcontainer/postCreateCommand.sh

@@ -1,22 +1,23 @@
 #!/bin/bash
 
+# Avoiding Dubious Ownership in Dev Containers for setup commands that use git
+# Note that the local workspace directory is passed through as the first argument $1
+git config --global --add safe.directory $1
+
 # create folders
-mkdir -p /workspaces/InvenTree/dev/{commandhistory,plugins}
-cd /workspaces/InvenTree
+mkdir -p $1/dev/{commandhistory,plugins}
+cd $1
 
 # create venv
 python3 -m venv dev/venv
 . dev/venv/bin/activate
 
-# Avoiding Dubious Ownership in Dev Containers for setup commands that use git
-git config --global --add safe.directory /workspaces/InvenTree
-
 # setup InvenTree server
 pip install invoke
-inv update
-inv setup-dev
+invoke update
+invoke setup-dev
 
 # remove existing gitconfig created by "Avoiding Dubious Ownership" step
-# so that it gets copyied from host to the container to have your global
+# so that it gets copied from host to the container to have your global
 # git config in container
 rm -f /home/vscode/.gitconfig