search

jupyter-server / jupyter_ydoc

Jupyter document structures for collaborative editing using Yjs/pycrdt
https://jupyter-ydoc.readthedocs.io
BSD 3-Clause "New" or "Revised" License
29 stars 17 forks source link

Rename JS package to `@jupyter/ydoc` #97

Closed jtpio closed 1 year ago

jtpio commented 1 year ago

Follow-up to https://github.com/jupyter-server/jupyter_ydoc/pull/86

This was discussed elsewhere on the JupyterLab repo.

Now that some of us managed to get a hold on the @jupyter scope on npm, it could interesting to rename this package to @jupyter/ydoc for consistency and early enough before it gets used more downstream.

cc @fcollonval

fcollonval commented 1 year ago

@meeseeksdev please backport to 0.2.x

lumberbot-app[bot] commented 1 year ago

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout 0.2.x
git pull

  1. Cherry pick the first parent branch of the this PR on top of the older branch:

    git cherry-pick -x -m1 4b0111f731abca3bc5ad4bd0cff57fcf2cdde2ed

  2. You will likely have some merge/cherry-pick conflict here, fix them and commit:

git commit -am 'Backport PR #97: Rename JS package to `@jupyter/ydoc`'
  1. Push to a named branch:
git push YOURFORK 0.2.x:auto-backport-of-pr-97-on-0.2.x
  1. Create a PR against branch 0.2.x, I would have named this PR:

"Backport PR #97 on branch 0.2.x (Rename JS package to @jupyter/ydoc)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

jtpio commented 1 year ago

Opened https://github.com/jupyterlab/jupyterlab/pull/13506 as a follow-up.