Skip to content
This repository has been archived by the owner on Nov 29, 2019. It is now read-only.

User guide examples for bokeh server and django #60

Merged
merged 7 commits into from
Jun 21, 2018
Merged

Conversation

ceball
Copy link
Member

@ceball ceball commented Jun 8, 2018

Not yet ready to review, except for two bits I'd like feedback on already:

  1. The example used to demonstrate parambokeh + bokeh server: see code in examples/apps/bokeh/simple.py

simple

  1. How to include the example app code in the notebook? You can see in the examples/user_guide/Bokeh_App notebook I've added a hack to be able to display each bit of the file as I talk about it...

screenshot from 2018-06-08 16-09-05

I could instead just copy/paste bits. Or I could not refer to the example specifically at all; just describe how to use parambokeh in bokeh server, and then at the end say "for a concrete example, see ...". Or maybe there's something better I could do?

@ceball ceball requested a review from jbednar June 8, 2018 21:25
Copy link
Member

@jbednar jbednar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me; it's hard to say without seeing it presented as an example. In the https://github.com/pyviz/pyviz/blob/master/notebooks/A2_Dashboard_Workflow.ipynb notebook, you can see that I handled the partial-app issue by introducing each bit of code on its own in the notebook, showing how each bit works, and only then showed the separate full app by dumping the file onscreen. The code in the snippets and the app then drift our of sync over time, of course, but at least the snippets let people understand it bit by bit and try it themselves. As you wish!

* `ViewParameters <View_Parameters.html>`_
Dynamically control some visual output.

* `Usage in Bokeh Apps <Bokeh_App.html>`_
How to use ParamBokeh in a Bokeh server application.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure "Usage in" adds anything here or below.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed

@ceball
Copy link
Member Author

ceball commented Jun 11, 2018

it's hard to say without seeing it presented as an example. In the https://github.com/pyviz/pyviz/blob/master/notebooks/A2_Dashboard_Workflow.ipynb notebook, you can see that I handled the partial-app issue by introducing each bit of code on its own in the notebook, showing how each bit works, and only then showed the separate full app by dumping the file onscreen. The code in the snippets and the app then drift our of sync over time, of course, but at least the snippets let people understand it bit by bit and try it themselves.

Maybe it's clearer if you look at the source only notebook?

https://github.com/ioam/parambokeh/blob/e27f7baa77039f20e8044476b146b807c040f279/examples/user_guide/Bokeh_App.ipynb

This approach does introduce the example bit by bit. It's just in desperation to avoid duplicating the code (which will inevitably go out of date as you say...), I have resorted to a hack (which would need to be hidden/imported from elsewhere).

Combined with the screenshot in the original comment above, which shows how it looks when the notebook is run (the code's there and can be copy/pasted etc), I think that should let you see the pros and cons.

Probably I vote for just doing what you did, and copy/pasting the code into the notebook.

@ceball
Copy link
Member Author

ceball commented Jun 21, 2018

If the website builds ok, I will merge. There are definitely improvements we could make to this documentation, but it's ready to receive user feedback, plus some improvement will come separately from reviewing the entire documentation after #61 is merged and when we switch to the new (still upcoming) release of nbsite (because the website editing process should then be easier, encouraging us to make the improvements).

@ceball ceball changed the title WIP: User guide examples for bokeh server and django User guide examples for bokeh server and django Jun 21, 2018
@ceball ceball merged commit 62310d0 into master Jun 21, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants