robotframework
WIP: Add live examples with Binder
For discussion and easier tracking of changes. Not for merge yet.
@bollwyvl I would appreciate your comments on this. https://robots-from-jupyter.github.io/BeginnersGuide/ I'm aware that Binder folks might not been too keen on Binder instances being embedded using iframe. I've tried to make this nice be only creating single Binder instance for a single visitor, storing the instance URL into short living cookie and reusing that same instance for every opened example (even the current documentation only includes single example).
(Obviously an alternative for this approach is to open the whole documentation with heavily themed Jupyter Notebook at binder. It would be technically much simpler with the only downside that user sees the Binder URL and not RobotFramework.org URL. I will probably do a such version for comparison when there's more content.)
Yeah I think that's fine: especially if you gate starting the container with the first call to the kernel. I'd also include a link to your full binder environment that's less "on rails" if people get excited.
There are even some tools to make it a little easier to do the embedding:
https://github.com/minrk/thebelab
But it looks like you have something up and read... Will take a look!
On Sat, Jan 18, 2020, 12:57 Asko Soukka [email protected] wrote:
For discussion and easier tracking of changes. Not for merge yet.
@bollwyvl https://github.com/bollwyvl I would appreciate your comments on this. https://robots-from-jupyter.github.io/BeginnersGuide/ I'm aware that Binder folks might not been too keen on Binder instances being embedded using iframe. I've tried to make this nice be only creating single Binder instance for a single visitor, storing the instance URL into short living cookie and reusing that same instance for every opened example (even the current documentation only includes single example).
[image: output] https://user-images.githubusercontent.com/160447/72668115-1d229880-3a2c-11ea-92e6-418fe1d2d0d0.gif
You can view, comment on, or merge this pull request online at:
https://github.com/robotframework/BeginnersGuide/pull/2 Commit Summary
- Add Binder configuration
File Changes
- M Examples/my_first.robot https://github.com/robotframework/BeginnersGuide/pull/2/files#diff-0 (4)
- M Examples/my_second.robot https://github.com/robotframework/BeginnersGuide/pull/2/files#diff-1 (4)
- M Examples/my_third.robot https://github.com/robotframework/BeginnersGuide/pull/2/files#diff-2 (4)
- M README.md https://github.com/robotframework/BeginnersGuide/pull/2/files#diff-3 (72)
- A binder/custom.css https://github.com/robotframework/BeginnersGuide/pull/2/files#diff-4 (31)
- A binder/environment.yml https://github.com/robotframework/BeginnersGuide/pull/2/files#diff-5 (12)
- A binder/example.md https://github.com/robotframework/BeginnersGuide/pull/2/files#diff-6 (29)
- A binder/example.robot https://github.com/robotframework/BeginnersGuide/pull/2/files#diff-7 (29)
- A binder/iframeResizer.contentWindow.min.js https://github.com/robotframework/BeginnersGuide/pull/2/files#diff-8 (29)
- A binder/jupyter_notebook_config.py https://github.com/robotframework/BeginnersGuide/pull/2/files#diff-9 (5)
- A binder/postBuild https://github.com/robotframework/BeginnersGuide/pull/2/files#diff-10 (14)
- A iframeResizer.min.js https://github.com/robotframework/BeginnersGuide/pull/2/files#diff-11 (8)
- A notebook-support.js https://github.com/robotframework/BeginnersGuide/pull/2/files#diff-12 (90)
Patch Links:
- https://github.com/robotframework/BeginnersGuide/pull/2.patch
- https://github.com/robotframework/BeginnersGuide/pull/2.diff
— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/robotframework/BeginnersGuide/pull/2?email_source=notifications&email_token=AAALCRATBYX5TQECX6RYEVLQ6M7J3A5CNFSM4KIUJMRKYY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4IHD2WDQ, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAALCRHVLCJ2M43XCWOX2WTQ6M7J3ANCNFSM4KIUJMRA .
@bollwyvl Thanks for your comments. The current WIP starts Binder on the background immediately, but I'll gate starting the container behind some intent if this proceeds.