-
Notifications
You must be signed in to change notification settings - Fork 2k
Misleading Proxy Server Configuration in Documentation #12856
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
Conversation
|
We require contributors to sign our Contributor License Agreement and we don't have one on file for @padeoe. In order for us to review and merge your code, please e-sign the Contributor License Agreement PDF. We then need to manually verify your signature, merge the PR (conda/infrastructure#786), and ping the bot to refresh the PR. |
|
@conda-bot check |
|
Just FYI, I committed your suggestion to the branch. I will get the opinion of some others now and will see if this is something we would like to merge to our documentation. |
jezdez
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This config option is sadly easy to get wrong, maybe it would be good to provide some real world examples or a tutorial?
Co-authored-by: Jannis Leidel <jannis@leidel.info>
kathatherine
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi, @padeoe, thank you so much for your patience on this. Your change was a bit lost in the shuffle, but we have rediscovered it! There were some pretty big changes to the conda docs organization since your addition, so I moved your changes to the correct file they should be in. Thank you for your contribution!
Description
I noticed a potential issue in the Conda documentation regarding the proxy server configuration.
Current example:
However, the 'https' key should also be specified using the HTTP protocol ('http://'), not HTTPS:
The
httpandhttpskeys indicate the type of traffic to route, not the protocol of the proxy server itself. As written, this could mislead users into thinking that the proxy server should use the HTTPS protocol forhttpstraffic.I suggest updating the documentation to prevent confusion.
Thank you for considering this issue.
Checklist - did you ...
newsdirectory (using the template) for the next release's release notes?