From acaf17913ded0364025423f8e3709485b673304c Mon Sep 17 00:00:00 2001 From: Seonaid Date: Fri, 19 Mar 2021 12:37:31 -0300 Subject: [PATCH] Update hugo testing instructions --- docs/content/usage/hugo-docs.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/content/usage/hugo-docs.md b/docs/content/usage/hugo-docs.md index 9c7e14f..ca7da42 100644 --- a/docs/content/usage/hugo-docs.md +++ b/docs/content/usage/hugo-docs.md @@ -27,6 +27,18 @@ The automatically generated starting point is in `docs/content/_index.md`. To pu For guidance on using hugo to layout your docs site, refer to [hugo documentation](https://gohugo.io/getting-started/usage/) +### Local testing + +Initialization of the hugo docs site with drumkit includes the addition of a `gitlab-ci.yml` file at the root of the project. + +This file is used by gitlab-runner to trigger the CI tests. + +**If you cloned using the development script, you will need to update the URL of the .mk submodule manually for these tests to run successfully.** + +Edit the submodule information in `.gitmodules` at the root of the containing project. Change the URL of .mk to: https://gitlab.com/consensus.enterprises/drumkit.git + + + ### Deployment The deployment to Gitlab Pages is managed automatically by the `.gitlab-ci.yml` file.