thebe icon indicating copy to clipboard operation
thebe copied to clipboard

Finish the rename + migration

Open choldgraf opened this issue 5 years ago • 8 comments

We've now moved this repository into executablebooks/ but there are still some things to take care of. This is an issue to keep track of this. @minrk let me know if I miss something!

  • [x] Rename references in the documentation to thebe instead of thebelab #273
  • [x] Update URLs to direct to the executablebooks/ org #275
  • [ ] Update the codebase so that thebelab becomes thebe (maybe with a deprecation cycle?)
  • [x] Set up the NPM library to publish as thebe instead of thebelab
  • [ ] Update developer documentation to EBP standards
  • [ ] Update testing infrastructure to EBP standards

choldgraf avatar Jul 27 '20 23:07 choldgraf

Ping also @chrisjsewell and @rowanc1 - I've added you both as admins on the thebe docs and you are both now maintainers on this repository as well.

ping also @phaustin - this is the main thebe (previously called thebelab) repository now. See the contributing guide for some basic information on getting involved. It would be great to see a round of improvements to this package!

Note that the sphinx extension for thebe is at the sphinx-thebelab repository

choldgraf avatar Aug 13 '20 01:08 choldgraf

See #273 for some partial updates!

rowanc1 avatar Oct 17 '20 23:10 rowanc1

According to https://github.com/executablebooks/thebe/issues/322#issuecomment-750139003, the library is now published to unpkg under a new name. @moorepants is that correct? Should

Set up the NPM library to publish as thebe instead of thebelab

Be considered done, and should everyone be recommended to update the URLs?

akhmerov avatar May 01 '21 12:05 akhmerov

Yes, it is pushed to unpkg as thebe now.

moorepants avatar May 03 '21 10:05 moorepants

Just looking at the todo list. do people think we need a deprecation cycle on the renaming name changes?

If so, what would one look like?

  • adding deprecation warnings in the next push
  • double up on the main object window.thebe = window.thebelab
  • double up on the class names added to different elements, and ensure either is valid? e.g. thebe-input & thebelab-input
  • etc...

then remove completely in the subsequent publish?

stevejpurves avatar Aug 09 '21 11:08 stevejpurves

I like doubling up instead of deprecating.

moorepants avatar Aug 16 '21 19:08 moorepants

I think doubling up for a few release cycles, then deprecating thebelab, is a good idea. No need to hurry that one up though, in the meantime just treating thebelab == thebe is a good start

choldgraf avatar Aug 16 '21 20:08 choldgraf

@choldgraf I have made changes to double up the js and CSS references to thebelab and thebe.

(current here https://github.com/stevejpurves/thebe/pull/45 on a stacked PR awaiting #472 coming in)

In terms of the remaining items on this issue, is there a good reference for the EBP developer and testing standards we can link to here?

stevejpurves avatar Oct 18 '21 19:10 stevejpurves