Web interface for 3-way merge in jupyterhub

jupyter / nbdime

Tools for diffing and merging of Jupyter notebooks.

http://nbdime.readthedocs.io

Other

2.66k stars 159 forks source link

Web interface for 3-way merge in jupyterhub #418

Open belonesox opened 6 years ago

belonesox commented 6 years ago

Hello.

I am trying to make jupyterhub/jupyterlab installation for my students, so they should use only web interface of jupyterhub.
I have read the docs, and searched for issues but still cannot get — is it possible to use nbdime 3way merge inside jupyterhub? (without working UI for 3way merge I even cannot imagine, how to implement jupyter collaboration for newbies)
- I see "diff/git" buttons from nbdime jupyterlab extension — they about local diff, not about merging.
- I tried to use "git mergetool --tool=nbdime" on jupyterhub server shell — nbdime trying to serve merge on localhost:
```
[I nbdimeserver:375] Listening on 127.0.0.1, port 36072
```
- I have seen #342, #341 but still cannot get, if is it possible to integrate nbdime with jupyterhub. Looks like this is possible by adding nbdime to "c.JupyterHub.services", but I am not sure how to make right configuration.

Please, if it possible, provide me link to right docs/code/samples.

vidartf commented 6 years ago

Hi!

This sounds like an interesting case. The answer to the question depends a lot on how you want to use it. If you just want normal git functionality, but able to resolve merge conflicts from the UI, I would:

Install/enable the nbdime merge driver.
After any actions that cause a merge conflict, the notebook will contain conflict markers. Open the notebook for editing, and resolve any conflicts as indicated by the markers.
git add <path> and git commit to mark the conflicts as resolved.
Alternatively, look into the extension @jupyterlab/git. It is still missing push/pull functionality, but hopefully it will get there. It should at least have the add/commit functionality.
Currently there is work to integrate nbdime with @jupyterlab/git so that nbdime is a "diff provider". It would be possible to extend this work to have nbdime be a "merge tool provider" as well.

If what you are looking for is simply merging three files (outside of git), there are other options as well.

vidartf commented 6 years ago

@belonesox Would you consider this issue as resolved? Do you have any suggestions for changes to the documentation for the future (e.g. based on what I talked about in the previous comment)?

belonesox commented 6 years ago

Sorry for delaying answers!

Install/enable the nbdime merge driver. After any actions that cause a merge conflict, the notebook will contain conflict markers. Open the notebook for editing, and resolve any conflicts as indicated by the markers.

Yes, already done it.

But wish to get better usability for newbies:

1) Buttons «git commit/git pull» (Yes, in that case it look like I have to develop @jupyterlab/git )
2) Button for git merge, that call something line "git mergetool --tool=nbdime" and instead of opening local "http://127.0.0.1:44011/mergetool?base=" it provide same interface (https://nbdime.readthedocs.io/en/stable/_images/nbmerge-web.png) on "http://jupyter.hub.my/something/mergetool?base="

Is "Case 2" too complex to be easily implemented?

vidartf commented 6 years ago

Case 2 is not super complex, but there is some wiring that needs to go into it. Where would you expect the button to be, and how should it work (how does it know which notebooks need merging?).