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.

Sign up for GitHub

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

Jump to bottom

Add docs to help users diagnose issues before creating them #6971

Merged
merged 7 commits into from Aug 9, 2019
Merged

Add docs to help users diagnose issues before creating them #6971

merged 7 commits into from Aug 9, 2019

Conversation

jasongrout
Copy link
Contributor

@jasongrout jasongrout commented Aug 8, 2019 •
edited

References

Code changes

Adds documentation to help users diagnose issues and create relevant and complete issues.

User-facing changes

Backwards-incompatible changes

None

TODO

  • Update the issue templates

@jasongrout jasongrout added this to the 1.1 milestone Aug 8, 2019
@jupyterlab-dev-mode
Copy link

Thanks for making a pull request to JupyterLab!

To try out this branch on binder, follow this link: Binder

@jasongrout jasongrout self-assigned this Aug 8, 2019
@jasongrout
Refine issue reporting documentation
9659f72
@jasongrout
Trim down the issue template to be more manageable for new contributors.
a64680f 
Also delete the installation issues template that doesn’t seem to be used very much.
@jasongrout
Copy link
Contributor Author

I think this is ready for feedback, except for pipenv instructions for creating a new fresh environment. Anyone know how to create a new environment in pipenv with a fresh JupyterLab install? @pivanov?

blink1073
blink1073 reviewed Aug 9, 2019
View reviewed changes
Copy link
Member

@blink1073 blink1073 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also mention checking for security software being enabled or trying a different browser to single out a browser compatibility issue?

docs/source/getting_started/issue.rst Outdated

jupyter lab

If you are using pipenv: (someone please update this area with instructions for creating a new environment in pipenv)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ha! I have not used pipenv.

@jasongrout
Copy link
Contributor Author

Should we also mention checking for security software being enabled or trying a different browser to single out a browser compatibility issue?

Good point.

I think I'm going to take out the 'disable browser extensions' - that has only rarely come up, and we can diagnose that on an issue. This is meant to be a filter to quickly catch the majority of issues that should be opened elsewhere.

@jasongrout
Copy link
Contributor Author

Should we also mention rying a different browser to single out a browser compatibility issue?

Done!

@jasongrout
Copy link
Contributor Author

checking for security software being enabled

I think this is rare enough we can diagnose that in an issue? Has it come up that often?

@blink1073
Copy link
Member

I've seen it manifest in accessing URLs, files, and the page itself.

@blink1073
Copy link
Member

Including weird stuff like a file with the name ad in it.

@blink1073
Copy link
Member

Also websocket security settings

@jasongrout
Copy link
Contributor Author

Done. Feel free to add to the short checklist I just added at the end of the diagnosis section.

@blink1073
Copy link
Member

Found a pipenv reference 😉

https://github.com/jupyterlab/jupyterlab/blob/1593760ac731234e48ba9c3701bb8dea1d5861ae/docs/source/getting_started/installation.rst#pipenv

@jasongrout
Copy link
Contributor Author

I spent a few minutes reading up on pipenv, and it still wasn't clear to me how to create a fresh new environment with nothing by jlab installed. I'll ask @pivanov :).

@blink1073
Copy link
Member

Looks good, thanks!

@blink1073 blink1073 merged commit 1365152 into jupyterlab:master Aug 9, 2019
@blink1073
Copy link
Member

@meeseeksdev backport to 1.0.x

meeseeksmachine pushed a commit to meeseeksmachine/jupyterlab that referenced this pull request Aug 9, 2019
@blink1073
Backport PR jupyterlab#6971: Add docs to help users diagnose issues b…
95c651f 
…efore creating them
@meeseeksmachine meeseeksmachine mentioned this pull request Aug 9, 2019
Merged
blink1073 added a commit that referenced this pull request Aug 9, 2019
@blink1073
Merge pull request #6986 from meeseeksmachine/auto-backport-of-pr-697…
9419461 
…1-on-1.0.x

Backport PR #6971 on branch 1.0.x (Add docs to help users diagnose issues before creating them)
krassowski added a commit to krassowski/jupyterlab that referenced this pull request Aug 12, 2019
@krassowski
Update issue.rst
361788d 
Fix a typo from jupyterlab#6971
@krassowski krassowski mentioned this pull request Aug 12, 2019
Merged
@lock lock bot added the status:resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion. label Sep 8, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Sep 8, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@blink1073 blink1073 blink1073 left review comments

Assignees

@jasongrout jasongrout

Labels
status:resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion.
Projects
None yet
Milestone
1.1
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@jasongrout @blink1073