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 Troubleshooting section #315

Closed
barbeau opened this issue Nov 28, 2017 · 0 comments

Comments

@barbeau
Copy link
Member

commented Nov 28, 2017

Summary:

We should add TROUBLESHOOTING.md, and just link to this file from a new "Troubleshooting" section in the README.

Things to add:

  1. enableSNIExtension - see #310 (comment)
  2. Java 9 compatibility - see #312

People will most likely stumble on this section when Googling the stack trace. I'd like to follow a similar design to this section:
https://github.com/OneBusAway/onebusaway/wiki/Troubleshooting#known-issues

...which has a "Symptom" and "Solution" section. The stack trace would go in the "Symptom" section, and the suggestion (e.g., to use -Djsse.enableSNIExtension=true) would go in "Solution".

Steps to reproduce:

Look for troubleshooting docs

Expected behavior:

Give me troubleshooting docs

Observed behavior:

No troubleshooting docs

Platform:

N/A

@barbeau barbeau added the enhancement label Nov 28, 2017

@barbeau barbeau added this to the v1.0 milestone Nov 28, 2017

@barbeau barbeau self-assigned this Nov 28, 2017

@barbeau barbeau closed this in 3978916 Mar 9, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.