From 76466b705454c54dd5ad27d4fc358316200fa0d5 Mon Sep 17 00:00:00 2001 From: Andrew Williams Date: Sat, 10 Feb 2024 12:24:27 +0000 Subject: [PATCH] Add deployment notes --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d062afc..c2df75f 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,21 @@ To run the site locally you can do the following: * Download [Hugo extended edition](https://github.com/gohugoio/hugo/releases/) (named hugo_extended). * Check out repo * Run `hugo serve -D --gc -w -F` (add -F to show content with future dates) or `make serve` (if you have `make` installed) -* Goto `http://localhost:1313/` +* Go to `http://localhost:1313/` to view the local instance. -The site will be updated in real-time with any changes made to the site. +The site will be updated in real time with any changes made to the site. ## Making Changes All changes to the website must be done on a branch and pushed through the GitHub pull requests workflow. If you have any questions about this process then contact the [Tech Infrastructure](https://wiki.leighhack.org/membership/useful_contacts/#tech-infrastructure) people. -## New Blog Post +## Deployment + +Branches are automatically deployed to [https://web-test.leighhack.org](https://web-test.leighhack.org) with subfolders for each of the branches in the repository. Once merged into `main` it'll be deployed out to the live website. + +## Common Tasks + +### New Blog Post * Download and install Hugo * Run `hugo new blog//name-of-post/index.md`, and a new file will be created in the right folder.