From de9307796340070c0b44e6325a902184ad65492a Mon Sep 17 00:00:00 2001 From: Johannes Christ Date: Sat, 27 Apr 2024 21:21:51 +0200 Subject: Move documentation to Hugo Shortly before merge, the repository settings need to be updated to set GitHub Actions as the deployment source, to prevent GitHub from trying to build with Jekyll. --- docs/README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'docs/README.md') diff --git a/docs/README.md b/docs/README.md index 362f76e..eaef124 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,9 @@ -# DevOps Knowledgebase +# DevOps documentation -## Local Development +This directory houses our DevOps documentation, written using +[Hugo](https://gohugo.io). -Run `bundle install` to install dependencies, then `bundle exec jekyll serve --config _config.yml,_config_dev.yml` to start locally. +To test changes to it locally, run `hugo serve` and follow the link displayed +on your Terminal. To generate all files, just run `hugo`. + + -- cgit v1.2.3