diff options
| author |  Johannes Christ <[email protected]> | 2024-04-27 21:21:51 +0200 |
|---|---|---|
| committer |  Joe Banks <[email protected]> | 2024-04-27 21:21:04 +0100 |
| commit | de9307796340070c0b44e6325a902184ad65492a (patch) | |
| tree | f7a873d1a4b14281580b0450ba77ee9290b22c3c /docs/README.md | |
| parent | Use same indent for all fail2ban options (diff) | |
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.
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 10 |
1 files changed, 7 insertions, 3 deletions
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`. + +<!-- vim: set textwidth=80 sw=2 ts=2: --> |