Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User guide: module definition: add 'proxy' attribute #994

Merged
merged 2 commits into from
May 16, 2022

Conversation

deining
Copy link
Collaborator

@deining deining commented Apr 28, 2022

#992 addressed how to deal with proxies, so it's a good thing to extend the documentation in order to alleviate the use of a proxy.
This PR closes #993.

@deining deining requested a review from LisaFC April 28, 2022 13:13
@deining deining force-pushed the module_proxy branch 4 times, most recently from f87b2d4 to a256048 Compare April 28, 2022 15:46
@LisaFC
Copy link
Collaborator

LisaFC commented May 13, 2022

This is great! Should we add something in the "Add theme module configuration..." intro section linking to the Hugo docs so users will know if/when they might need to change things? Something like:

You can find details of what these configuration settings do in the Hugo modules documentation. Depending on your environment you may need to tweak them slightly, for example by adding a proxy to use when downloading remote modules.

Also is the proxy issue likely to show up for users who have copied the example site instead, in which case we should probably put a note in those docs too.

I can update it myself in this PR or a subsequent one?

@deining
Copy link
Collaborator Author

deining commented May 13, 2022

This is great!

Glad you like it!

Should we add something in the "Add theme module configuration..." intro section linking to the Hugo docs so users will know if/when they might need to change things? Something like:

You can find details of what these configuration settings do in the Hugo modules documentation. Depending on your environment you may need to tweak them slightly, for example by adding a proxy to use when downloading remote modules.

Yes, good idea. Wording sounds clear to me.

Also is the proxy issue likely to show up for users who have copied the example site instead, in which case we should probably put a note in those docs too.

Yes. And we should add proxy = "direct" to the config.toml used by the example site. I will author a PR for this shortly.

I can update it myself in this PR or a subsequent one?

Yes, go ahead. I'm glad if you update my exisiting PR with your useful suggestions. Looking forward to get this PR merged!

@LisaFC
Copy link
Collaborator

LisaFC commented May 16, 2022

Excellent!

@LisaFC LisaFC merged commit 3641b24 into google:main May 16, 2022
@deining deining deleted the module_proxy branch May 16, 2022 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

User guide, module installation: add instructions how to deal with a proxy server
2 participants