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

Create troubleshooting page in docs #587

Open
waldekmastykarz opened this issue Feb 26, 2024 · 2 comments
Open

Create troubleshooting page in docs #587

waldekmastykarz opened this issue Feb 26, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@waldekmastykarz
Copy link
Collaborator

To help customers troubleshoot proxy not working as intended, we should create a page to which we can point to in-product, from issues, on social, etc.

The page should contain walk customers through the same troubleshooting steps that we'd take if we're to help them 1:1. Proposed structure:

Symptom: Proxy is not intercepting requests

  • no requests intercepted
    • is proxy running
    • is it registered as system proxy
    • Have you configured correct url to watch
    • Are you using the right config file
    • Are you using proxy with a Node app
    • Are you using proxy with PowerShell on Windows

Symptom: Requests intercepted but passed through

Symptom: You get an SSL error in your app when using Dev Proxy:

  • Do you have the proxy cert installed
  • Is it trusted
@waldekmastykarz waldekmastykarz added documentation Improvements or additions to documentation needs peer review Issue needs review from other team members labels Feb 26, 2024
@garrytrinder
Copy link
Contributor

Nice idea.

How would folks get to the page and how would they know that it exists?

Are you thinking of a doctor command?

@waldekmastykarz
Copy link
Collaborator Author

To raise awareness of the page, we should do the following:

  • have an aka link, eg. aka.ms/devproxy/help
  • show the link when proxy starts
  • show the link when folks invoke help on-demand Press 'h'/'?' to get troubleshooting information #586
  • show the link on the issue template so that folks can debug proxy before they submit an issue

I'm not sure if a doctor command would help us automatically detect the things that need to be checked in order to determine what's wrong.

@waldekmastykarz waldekmastykarz removed the needs peer review Issue needs review from other team members label Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants