thebe
thebe copied to clipboard
Finish the rename + migration
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
thebeinstead ofthebelab#273 - [x] Update URLs to direct to the
executablebooks/org #275 - [ ] Update the codebase so that
thebelabbecomesthebe(maybe with a deprecation cycle?) - [x] Set up the NPM library to publish as
thebeinstead ofthebelab - [ ] Update developer documentation to EBP standards
- [ ] Update testing infrastructure to EBP standards
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
See #273 for some partial updates!
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
thebeinstead ofthebelab
Be considered done, and should everyone be recommended to update the URLs?
Yes, it is pushed to unpkg as thebe now.
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?
I like doubling up instead of deprecating.
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 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?