Merge pull request #483 from 02JanDal/update-run-docs

Clean up unused methods to run and deploy the site
qgis · Nov 27, 2024 · 8d13562 · 8d13562
2 parents 543613c + 63a3d19
commit 8d13562
Show file tree

Hide file tree

Showing 10 changed files with 10 additions and 325 deletions.
diff --git a/.github/workflows/deploy-prod.yml b/.github/workflows/deploy-prod.yml
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -31,41 +31,6 @@
             // see tasks.json for definition
             "preLaunchTask": "dev build", // The name of the task defined above
             "request": "attach"
-        },
-        {
-            "name": "Run Dev Under Docker",
-            "type": "shell",
-            // see tasks.json for definition
-            "preLaunchTask": "dev", // The name of the task defined above
-            "request": "attach"
-        },
-        {
-            "name": "Run Dev with Metrics",
-            "type": "shell",
-            // see tasks.json for definition
-            "preLaunchTask": "dev-metrics", // The name of the task defined above
-            "request": "attach"
-        },
-        {
-            "name": "Deploy Production",
-            "type": "shell",
-            // see tasks.json for definition
-            "preLaunchTask": "deploy-prod", // The name of the task defined above
-            "request": "attach"
-        },
-        {
-            "name": "Run Tests",
-            "type": "shell",
-            // see tasks.json for definition
-            "preLaunchTask": "tests", // The name of the task defined above
-            "request": "attach"
-        },
-        {
-            "name": "Run Help",
-            "type": "shell",
-            // see tasks.json for definition
-            "preLaunchTask": "help", // The name of the task defined above
-            "request": "attach"
         }
     ]
 }
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -41,60 +41,6 @@
                 "_id": "test",
                 "isDefault": false
             }
-        },
-        {
-            "label": "dev build",
-            "type": "shell",
-            "command": "bash",
-            "args": ["-c", "make dev-build"],
-            "problemMatcher": [],
-            "group": {
-                "_id": "build",
-                "isDefault": false
-            }
-        },
-        {
-            "label": "dev",
-            "type": "shell",
-            "command": "bash",
-            "args": ["-c", "make dev"],
-            "problemMatcher": [],
-            "group": {
-                "_id": "test",
-                "isDefault": false
-            }
-        },
-        {
-            "label": "dev-metrics",
-            "type": "shell",
-            "command": "bash",
-            "args": ["-c", "make dev-metrics"],
-            "problemMatcher": []
-        },
-        {
-            "label": "deploy-prod",
-            "type": "shell",
-            "command": "bash",
-            "args": ["-c", "make deploy-prod"],
-            "problemMatcher": [],
-            "group": {
-                "_id": "test",
-                "isDefault": false
-            }
-        },
-        {
-            "label": "tests",
-            "type": "shell",
-            "command": "bash",
-            "args": ["-c", "make dev-metrics"],
-            "problemMatcher": []
-        },
-        {
-            "label": "help",
-            "type": "shell",
-            "command": "bash",
-            "args": ["-c", "make help"],
-            "problemMatcher": []
         }
     ]
 }
diff --git a/.vscode/tasks.json.old b/.vscode/tasks.json.old
diff --git a/Dockerfile b/Dockerfile
diff --git a/Dockerfile.dev b/Dockerfile.dev
diff --git a/Dockerfile.tests b/Dockerfile.tests
diff --git a/Makefile b/Makefile
@@ -11,29 +11,6 @@ help:
 	@echo "------------------------------------------------------------------"
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort  | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m - %s\n", $$1, $$2}'
 
-# ----------------------------------------------------------------------------
-#    D O C K E R     C O M M A N D S
-# ----------------------------------------------------------------------------
-
-dev-build: ## Generate the development docker container
-	docker build --rm -f Dockerfile.dev -t qgis_hugo_dev:latest .
-
-dev: dev-build ## Run the development hugo container
-	docker run --rm -it -v "$${PWD}":/app -w /app -p $${HOST_IP:-127.0.0.1}:1313:1313 qgis_hugo_dev:latest
-
-dev-metrics: dev-build ## Run the development hugo container with metrics
-	docker run --rm -it -v "$${PWD}":/app -w /app -p $${HOST_IP:-127.0.0.1}:1313:1313 qgis_hugo_dev:latest serve -D --bind 0.0.0.0 --templateMetrics --templateMetricsHints
-
-deploy-prod: ## Deploy everything to production
-	docker build -t qgis.org .
-	docker-compose -f ~/docker-compose.yml up -d qgis_hugo_prod
-	docker image prune -af
-
-tests: ## Run the test suite
-	docker build --rm -f Dockerfile.tests -t qgis_hugo_tests:latest .
-	docker run --rm --net=host --volume "$${PWD}":/app -w /app qgis_hugo_tests:latest
-
-
 # ----------------------------------------------------------------------------
 #    P R O D U C T I O N     C O M M A N D S
 # ----------------------------------------------------------------------------

diff --git a/README.md b/README.md
@@ -95,6 +95,16 @@ Once the site is running, you can open it at:
 
 The site will automatically refresh any page you have open if you edit it and save your work. Magical eh?
 
+## Run in other IDEs
+
+Use an appropriate Hugo plugin for your IDE, or run Hugo från the command line:
+
+```shell
+hugo server
+```
+
+You can then visit the hot-reloaded site in your browser at `http://localhost:1313/`
+
 ## Running Playwright End to End (e2e) Tests
 
 Test files are located in ```playwright/ci-test/tests```.

diff --git a/docker-compose.yml b/docker-compose.yml