Merge branch 'release/5.5.0'

Author: pascalberger

.devcontainer/devcontainer.json

@@ -0,0 +1,26 @@
+{
+	"name": "Website editing",
+	"image": "python:3.13.1-slim-bookworm",
+	"workspaceMount": "source=${localWorkspaceFolder}/docs,target=/docs,type=bind",
+	"workspaceFolder": "/docs",
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	"features": {},
+
+	"forwardPorts": [
+		8000
+	],
+
+	"postCreateCommand": "pip install -r requirements.txt",
+
+	"customizations": {
+		"vscode": {
+			"settings": {
+				"terminal.integrated.shell.linux": "/bin/bash",
+			},
+			"extensions": [
+				"davidanson.vscode-markdownlint"
+			]
+		}
+	}
+}

.gitattributes

@@ -1,4 +1,7 @@
 # Enforce Windows newlines for C# files to be aligned with editorconfig.
 *.cs text eol=crlf
-
 *.cs diff=csharp
+# Binary files tracked by LFS
+*.gif filter=lfs diff=lfs merge=lfs -text
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text

.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Program",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${file}"
+        }
+    ]
+}

docs/.vscode/launch.json

@@ -0,0 +1,13 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Preview Website",
+            "type": "chrome",
+            "request": "launch",
+            "url": "http://127.0.0.1:8000",
+            "preLaunchTask": "mkdocs-serve",
+            "postDebugTask": "mkdocs-stop"
+        }
+    ]
+}

docs/.vscode/tasks.json

@@ -0,0 +1,27 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "mkdocs-serve",
+            "type": "shell",
+            "isBackground": true,
+            "command": "mkdocs serve",
+            "problemMatcher": {
+                "owner": "custom",
+                "pattern": {
+                    "regexp": "^.*(Error|Except).*$"
+                },
+                "background": {
+                    "activeOnStart": true,
+                    "beginsPattern": ".*Building documentation.*",
+                    "endsPattern": ".*Serving on.*"
+                }
+            }
+        },
+        {
+            "label": "mkdocs-stop",
+            "type": "shell",
+            "command": "${command:workbench.action.terminal.kill}"
+        }
+    ]
+}

docs/input/documentation/contributing/how-to-build.md

@@ -39,31 +39,49 @@ To run only part of the build a task can be passed using the `--target=<TASK>` s
 
 ## Building and running website locally
 
-Ensure the following prerequisites are fulfilled:
-
-* Latest .NET version installed
-* Python 3 installed
-
-To build and serve the website [Cake]{target="_blank"} is used:
-
-=== ":material-microsoft-windows: Windows"
-
-    ```powershell
-    .\build.ps1 --target=website
-    ```
-
-=== ":material-apple: macOS"
-
-    ```bash
-    ./build.sh --target=website
-    ```
-
-=== ":material-linux: Linux"
-
-    ```bash
-    ./build.sh --target=website
-    ```
-
-Website is available on `http://127.0.0.1:8000/`
+=== "Using Visual Studio Code Dev Container"
+
+    For building and running website locally a [Visual Studio Code Dev Container]{target="_blank"} can be used.
+
+    Follow [installation instructions]{target="_blank"} to setup prerequisites.
+
+    To build and serve the website follow these steps:
+
+    * Clone and open the repository in Visual Studio Code
+    * Open the website Dev Container: ++f1++ :material-arrow-right: `Dev Containers: Reopen in Container`
+    * Start website in preview mode: ++f5++
+
+    Website preview will be opened in Chrome.
+
+=== "Running on local machine"
+
+    Ensure the following prerequisites are fulfilled:
+    
+    * Latest .NET version installed
+    * Python 3 installed
+    
+    To build and serve the website [Cake]{target="_blank"} is used:
+    
+    === ":material-microsoft-windows: Windows"
+    
+        ```powershell
+        .\build.ps1 --target=website
+        ```
+    
+    === ":material-apple: macOS"
+    
+        ```bash
+        ./build.sh --target=website
+        ```
+    
+    === ":material-linux: Linux"
+    
+        ```bash
+        ./build.sh --target=website
+        ```
+    
+    Website is available on `http://127.0.0.1:8000/`
 
 [Cake]: https://cakebuild.net/
+[Visual Studio Code Dev Container]: https://code.visualstudio.com/docs/devcontainers/containers
+[installation instructions]: https://code.visualstudio.com/docs/devcontainers/containers#_installation