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

Add Proxy Configuration to References #1486

Merged
merged 5 commits into from Apr 1, 2019

Conversation

2 participants
@flotwig
Copy link
Member

commented Mar 13, 2019

Documents changes from cypress-io/cypress#3531

Is the Configuration page a good spot for this?

@flotwig flotwig referenced this pull request Mar 13, 2019

Merged

Improved proxy support #3531

38 of 38 tasks complete

@flotwig flotwig changed the title [WIP] Add Proxy Configuration to Configuration Add Proxy Configuration to Configuration Mar 13, 2019

@jennifer-shehane jennifer-shehane self-requested a review Mar 14, 2019

@jennifer-shehane
Copy link
Member

left a 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:

  1. Explain that Cypress may not work until the proper proxy is configured. What does "not work" look like?
  2. Why doesn't Cypress "just work" - why do I need to even bother doing these extra things? Explain why.
  3. 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.
  4. 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).
  5. 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

I understand you have other work - so it's fine if you do not make all of these updates. I can pick it up.

@flotwig

This comment has been minimized.

Copy link
Member Author

commented Mar 14, 2019

@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 flotwig requested a review from jennifer-shehane Mar 14, 2019

@jennifer-shehane

This comment has been minimized.

Copy link
Member

commented Mar 15, 2019

@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 flotwig changed the title Add Proxy Configuration to Configuration Add Proxy Configuration to References Mar 15, 2019

jennifer-shehane added some commits Mar 19, 2019

Minor updates
@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`

@jennifer-shehane jennifer-shehane changed the base branch from develop to 3.3.0-release Apr 1, 2019

@jennifer-shehane jennifer-shehane merged commit 8d48dfa into 3.3.0-release Apr 1, 2019

3 checks passed

ci/circleci: build Your tests passed on CircleCI!
Details
ci/circleci: docs-tests Your tests passed on CircleCI!
Details
license/cla Contributor License Agreement is signed.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.