User guide: add note on using a proxy when downloading docsy as hugo …

…module
google · May 16, 2022 · a7239e4 · a7239e4
1 parent 8741151
commit a7239e4
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/userguide/content/en/docs/Get started/Docsy-As-Module/example-site-as-template.md b/userguide/content/en/docs/Get started/Docsy-As-Module/example-site-as-template.md
@@ -59,6 +59,12 @@ As the Docsy example site repo is a [template repository](https://github.blog/20
     </pre>
 
 Now you can make local edits and test your copied site locally with Hugo.
+{{% alert title="Note" color="primary" %}}
+Depending on your environment you may need to tweak the [module top level settings](https://github.com/google/docsy-example/blob/1c7f7e300c90cd690ca5be66b43fe58713bb21c9/config.toml#L221-L228) inside your `config.toml` slightly, for example by adding a proxy to use when downloading remote modules.
+You can find details of what these configuration settings do in the [Hugo modules documentation](https://gohugo.io/hugo-modules/configuration/#module-config-top-level). 
+{{% /alert %}}
+
+Once your site is up and running, you can edit your own versions of the site’s source files.
 
 ### Preview your site
 

diff --git a/userguide/content/en/docs/Get started/Docsy-As-Module/start-from-scratch.md b/userguide/content/en/docs/Get started/Docsy-As-Module/start-from-scratch.md
@@ -143,6 +143,9 @@ module:
 {{< /tab >}}
 {{< /tabpane >}}
 
+You can find details of what these configuration settings do in the [Hugo modules documentation](https://gohugo.io/hugo-modules/configuration/#module-config-top-level).
+Depending on your environment you may need to tweak them slightly, for example by adding a proxy to use when downloading remote modules.
+
 ### Preview your site
 
 To build and preview your site locally:

diff --git a/userguide/content/en/docs/Updating/Convert-site-to-module.md b/userguide/content/en/docs/Updating/Convert-site-to-module.md
@@ -142,6 +142,9 @@ module:
 {{< /tab >}}
 {{< /tabpane >}}
 
+You can find details of what these configuration settings do in the [Hugo modules documentation](https://gohugo.io/hugo-modules/configuration/#module-config-top-level).
+Depending on your environment you may need to tweak them slightly, for example by adding a proxy to use when downloading remote modules.
+
 {{% alert title="Attention" color="warning" %}}
 If you have a multi language installation, please make sure that the section `[languages]` inside your `config.toml` is declared before the section `[module]` with the module imports. Otherwise you will run into trouble!
 {{% /alert %}}