Add .devcontainer configuration files and VS Code tasks.json

Author: Slava Katiukha

.devcontainer/Dockerfile

@@ -0,0 +1,19 @@
+FROM jetpackio/devbox:latest
+
+# Installing your devbox project
+WORKDIR /code
+USER root:root
+RUN mkdir -p /code && chown ${DEVBOX_USER}:${DEVBOX_USER} /code
+USER ${DEVBOX_USER}:${DEVBOX_USER}
+
+COPY --chown=${DEVBOX_USER}:${DEVBOX_USER} 3rdparty ./3rdparty
+COPY --chown=${DEVBOX_USER}:${DEVBOX_USER} plugins ./plugins
+
+COPY --chown=${DEVBOX_USER}:${DEVBOX_USER} devbox.json devbox.json
+COPY --chown=${DEVBOX_USER}:${DEVBOX_USER} devbox.lock devbox.lock
+COPY --chown=${DEVBOX_USER}:${DEVBOX_USER} Pipfile Pipfile$
+COPY --chown=${DEVBOX_USER}:${DEVBOX_USER} Pipfile.lock Pipfile.lock
+COPY --chown=${DEVBOX_USER}:${DEVBOX_USER} Taskfile.yaml Taskfile.yaml
+
+RUN devbox run -- echo "Installed Packages."
+RUN devbox shellenv --init-hook >> ~/.profile 

.devcontainer/devcontainer.json

@@ -0,0 +1,16 @@
+{
+  "name": "Devbox Remote Container",
+  "build": {
+    "dockerfile": "./Dockerfile",
+    "context": ".."
+  },
+  "customizations": {
+    "vscode": {
+      "settings": {},
+      "extensions": [
+        "jetpack-io.devbox"
+      ]
+    }
+  },
+  "remoteUser": "devbox"
+}

.vscode/tasks.json

@@ -0,0 +1,29 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Start the Docs web server",
+            "type": "shell",
+            "osx": {
+                "command": "command -v devbox &> /dev/null || (curl -fsSL https://get.jetpack.io/devbox | bash) && devbox run serve"
+            },
+            "linux": {
+                "command": "command -v devbox &> /dev/null || (curl -fsSL https://get.jetpack.io/devbox | bash) && devbox run serve"
+            },
+            "windows": {
+                "command": "where devbox >nul 2>&1 || (echo 'Devbox is not installed. Please visit https://www.jetpack.io/devbox/docs/installing_devbox/ for installation instructions.') && devbox run serve"
+            },
+            "problemMatcher": [],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "presentation": {
+                "reveal": "always",
+                "panel": "new"
+            }
+        }
+    ]
+}

Pipfile.lock

@@ -1,17 +1,52 @@
-# Staging the docs on local machine
+# Staging the Docs on Your Local Machine
 
-1. Clone this repo and run installation script:
-```
-git clone https://github.com/virtuozzo/docs.git
-cd docs
-sudo ./install.sh
-```
+This guide walks you through the process of staging the documentation locally using either a Devbox or a Dev Container. First, you need to clone the repository:
 
-2. To run the docs, issue the following command:
-```
-mkdocs serve 
+```bash
+git clone [email protected]:virtuozzo/cloudscripting-docs.git
+cd cloudscripting-docs
 ```
-MkDocs incrementally rebuilds the site each time a file changes.
-You can keep your browser open to [http://localhost:8000/](http://localhost:8000/) and refresh to see the changes.  
-Use CTRL+C to stop the server and get the command prompt back.
 
+After cloning the repository, you have two options to run the docs web server: using a Devbox isolated shell or a Dev Container.
+
+**Devbox** provides a faster alternative by installing all dependencies into an isolated shell, while **Dev Container** offers more isolation and could be simpler to install.
+
+## Using Devbox
+
+Devbox is recommended for users who prefer a quick setup with isolated environments. Follow these steps to use Devbox:
+
+1. Install Devbox from [here](https://www.jetpack.io/devbox/docs/installing_devbox/).
+2. To start the docs web server, execute one of the following commands:
+
+    ```bash
+    devbox run serve
+    ```
+
+    or
+
+    ```bash
+    devbox shell
+    task serve
+    ```
+
+Alternatively, in VS Code, you can run the `Start the Docs web server` task, which automatically starts the local server for the documentation. To do this:
+
+- Use the command palette in VS Code (Ctrl+Shift+P or Cmd+Shift+P), type `Tasks: Run Task`, and select `Start the Docs web server`.
+- Or, navigate to `Terminal -> Run Task...` and choose `Start the Docs web server`.
+
+## Using a Dev Container
+
+For those preferring VS Code and seeking greater isolation, the Dev Container method is ideal. Follow these steps:
+
+1. Install the **Dev Containers** extension in VS Code.
+2. Open the `cloudscripting-docs` repository in VS Code.
+3. Use the command palette (Ctrl+Shift+P or Cmd+Shift+P), type `Dev Containers: Reopen in Container`, and select it.
+4. VS Code will rebuild the container using the `.devcontainer` folder's configuration.
+5. Once the container is ready, you're set to work within the Dev Container environment.
+6. To start the docs, issue this command in the integrated terminal:
+
+    ```bash
+    task serve
+    ```
+
+MkDocs will incrementally rebuild the site with each file change. Keep your browser open to [http://localhost:8000/](http://localhost:8000/) and refresh to view updates. Use CTRL+C in the terminal to stop the server.

README.md

@@ -1,18 +1,34 @@
 version: "3"
 
 tasks:
+  check-and-install-deps:
+    desc: "Check and install dependencies"
+    cmds:
+      - pipenv run which mkdocs && pipenv install --dev || true
+    internal: true
+
   serve:
     desc: "Start the development server"
+    deps:
+      - check-and-install-deps
     cmds:
       - pipenv run mkdocs serve
 
   build:
     desc: "Build the current version of the documentation"
+    deps:
+      - check-and-install-deps
     cmds:
       - pipenv run mkdocs build
 
   build-all:
-    desc: "Build all versions described in the mkdocs.yml"
+    desc: >-
+      Build all versions described in the mkdocs.yml for production.
+      Make sure to commit the changes before running this task.
+      All uncommitted changes will be stashed and can be restored via 'git stash apply 0' in the branch you were working on.
+
+    deps:
+      - check-and-install-deps
     cmds:
       - DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )";
         VERSION=$1;

Taskfile.yaml

@@ -1,17 +1,17 @@
 {
   "packages": {
-    "python":  "3.5.9",
-    "pipenv":  "2020.6.2",
+    "python": "3.5.9",
+    "pipenv": "2020.6.2",
     "go-task": "3.35.1"
   },
   "shell": {
     "init_hook": [
       ""
     ],
     "scripts": {
-      "serve":     "task serve",
-      "build":     "task build",
+      "serve": "task serve",
+      "build": "task build",
       "build-all": "task build-all"
     }
   }
-}
+}