Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A more extensive and updated project intro in the README #12

Open
1 of 8 tasks
consideRatio opened this issue Jul 25, 2021 · 4 comments
Open
1 of 8 tasks

A more extensive and updated project intro in the README #12

consideRatio opened this issue Jul 25, 2021 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@consideRatio
Copy link
Member

consideRatio commented Jul 25, 2021

I'd love to use and contribute with maintenance of this project, but I struggle to understand enough about it to feel confident on how to install it etc.

Here are some points that i think could be addressed within the README:

  • TightVNC is mentioned, but it is TigerVNC that is vendored in (a fork of TightVNC).
  • websockify is a required dependency, but that is not documented
    • pip install of websockify doesn't seem to cut it, but conda install -c conda-forge does. Perhaps that is why it is not listed under install_requires in setup.py?
  • __init__.py points to share/xstartup, which in turn does exec /usr/bin/dbus-launch xfce4-session, making me think that the apt packages dbus-x11 and xfce4-session are strictly required.
  • What apt packages are required?
    As xfce4-session is required, perhaps is xorg (x11?) and other xfce4 packages strictly required as well?
  • A "how it works" section like in jupyterhub-idle-culler's README
    Having an explanations of how it works technically could help me a lot to use and contribute to this project!
  • Is the Dockerfile supposed to be used for binderhub, or is it a published artifact?
  • Is the Python package published?
    If it is or should be, we should use a badge
    If it is not, why isn't it published and should it be soon?
  • What is supposed to be exposed via the /panel path?
    image
@consideRatio consideRatio added the documentation Improvements or additions to documentation label Jul 25, 2021
@welcome

This comment has been minimized.

@manics
Copy link
Member

manics commented Jul 26, 2021

The README is a bit out of date, I'll work on it!

/panel: Nothing to do with this repo, do you have some other extension installed?

@consideRatio
Copy link
Member Author

Thanks @manics! /panel confusion resolved

In [4]: from importlib import metadata
   ...: metadata.entry_points()["jupyter_serverproxy_servers"]
Out[4]: 
(EntryPoint(name='panel', value='panel_server:setup_panel_server', group='jupyter_serverproxy_servers'),
 EntryPoint(name='desktop', value='jupyter_desktop:setup_desktop', group='jupyter_serverproxy_servers'))

Ah, found it to be related to https://github.com/holoviz/jupyter-panel-proxy being installed.

@yuvipanda
Copy link
Contributor

I wrote https://github.com/yuvipanda/binder-desktop-app-template as a template that can be used to generate repos to launch specific GUI apps.

yuvipanda added a commit that referenced this issue Jan 14, 2023
OpenGL is currently not supported, and we should
document this in the README. 

I hope this is not considered to be blocked by
#12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants