Open maxrjones opened 1 month ago
PR Preview Action v1.4.7
:---:
:rocket: Deployed preview to https://NASA-IMPACT.github.io/veda-docs/pr-preview/pr-158/
on branch gh-pages
at 2024-08-15 20:58 UTC
Thanks for the review @jsignell! @wildintellect mentioned that this setup may still be confusing to users, so I'm going to try out recording a quick video explanation (hopefully tomorrow). So, I'll hold off on merging this for a short while and may ping you for another review.
that error does seem likely relating to an existing setup. I can add a warning and perhaps we should also include a section in the JupyterHub section of the docs on where users can go to reach out for help. Is the IMPACT slack where that help would happen?
Step 1. Clarify that an Org admin has to setup the initial permissions. Step 2.
Second, you need to authorize the app on the Hub. This needs to be done once every 8 hours. Does every user need to do this? So basically it's once per working day? Can we include
gh-scoped-creds.ipynb
in the docs repo, so that users just need to open it and run it? (we already checkout the docs in Pangeo workspaces)
The whole thing feels reverse order for actual user usage.
This PR adds a new section to
Usage Examples
calledJupyterHub
. It currently contains one markdown fileHow to push to GitHub from the VEDA JupyterHub
but I think the new section would be helpful for other upcoming improvements (e.g., additional IDEs). While there's some redundancy with the 2i2c docs, I think the 2i2c docs offer cover background and reasons for things being done a certain way (which is useful for their audience), whereas these how-to guides would provide the minimal required explanation for solving a user's problem.