Add Proxy Configuration to References #1486
Conversation
flotwig
changed the title
There was a problem hiding this comment.
Yeah, I don't think this is a great spot. This page has currently only been used for any values that could be set inside cypress.json
I'm ok with creating a new guide to be honest. I think shorter, more specific guides are a better direction for us to go in.
In general feedback:
- Explain that Cypress may not work until the proper proxy is configured. What does "not work" look like?
- Why doesn't Cypress "just work" - why do I need to even bother doing these extra things? Explain why.
- Explain how to determine whether they are behind a proxy - is there some simple steps they can check if they're not sure they're behind one.
- Be VERY clear that they need to set their platform / operating system environment variables - this is NOT cypress environment variables (you may even clearer say that they are different to be extra clear).
- We need to sprinkle in some more keywords here so that this is easily searched like. Some keywords I've seen from issues that are may be helpful from this doc are: "corporate", "port", "exclusion", "CDN", "credentials", "network", "auto-configuration", "VPN", "external", "reverse", "SSL", "ProxyMode", "machine", "resources", "firewall"
Some inspiration
- https://docs.chef.io/proxies.html
- https://docs.docker.com/network/proxy/
- https://docs.pivotal.io/pcf-dev/proxy.html
- https://learning.getpostman.com/docs/postman/sending_api_requests/proxy/
I understand you have other work - so it's fine if you do not make all of these updates. I can pick it up.
|
@jennifer-shehane Thanks for the review. I moved the proxy configuration to it's own page in References, added some explanations for why Cypress needs a proxy to work and what that looks like, clarified the environment variables thing, and added some of those keywords that people might search for. I also added a section on how to check out their proxy config through the UI. It might still need some work, so if you want to make some changes, please feel free to pick it up. Re: adding info on how they can check if they're behind a proxy, I'm not sure about that. There are tools like http://amibehindaproxy.com/ that do some simple HTTP header checks, but it's easy to get a false positive/false negative and it might just confuse users more. I thought about saying "Unsure if you're behind a network proxy? Contact your administrator." in an infobox but I felt like that might be too obvious to bother writing. I'm open to suggestions. |
|
@flotwig Right, I thought there may be an easier way to determine your proxy server, but I guess you're right - they likely don't have permissions to even check this. I will review sometime today. |
flotwig
changed the title
@flotwig - When link to a header within the same doc, use `urlhash` instead of `url`. - When linking to other doc pages, only reference the final document name, so instead of `guides/references/configuration`, just put `configuration`
Documents changes from cypress-io/cypress#3531
Is the Configuration page a good spot for this?