search

NASA-IMPACT / veda-docs

Documentation for the VEDA Project
https://nasa-impact.github.io/veda-docs
Apache License 2.0
7 stars 7 forks source link

Add instructions for pushing to GitHub from the VEDA Hub #158

Closed maxrjones closed 1 week ago

maxrjones commented 3 months ago

This PR adds a new section to Usage Examples called JupyterHub. It currently contains one markdown file How 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.

github-actions[bot] commented 3 months ago

PR Preview Action v1.4.8 :---: :rocket: Deployed preview to https://NASA-IMPACT.github.io/veda-docs/pr-preview/pr-158/ on branch gh-pages at 2024-11-13 22:25 UTC

maxrjones commented 3 months ago

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?

wildintellect commented 3 months ago

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.

  1. Remember to clone your repos with https, NOTE: github token is the alternative to this method
  2. Authorize once per day (Every 8 hours) <- I wonder if we could make a widget or if the jupyter github extension incorporates this
  3. First time Config for Repos/Organizations (maybe mention at top and link to bottom?
wildintellect commented 3 weeks ago

@maxrjones looks close I think the only thing missing is a copy of that notebook in the PR that goes into notebooks/templates ? open to other location ideas. I just don't want it to only exist in the shared folder on VEDA where it can go missing.

maxrjones commented 3 weeks ago

@maxrjones looks close I think the only thing missing is a copy of that notebook in the PR that goes into notebooks/templates ? open to other location ideas. I just don't want it to only exist in the shared folder on VEDA where it can go missing.

It's just two lines of code which are shown in the GIF. Also, only admins should be able to modify the shared-readwrite directory, so I think the risk here is minimal.

Relatedly, could you please create that notebook in shared-readwrite? I would offer to become an admin, but I actually think it's useful for me to have the same experience as a typical VEDA user.

maxrjones commented 1 week ago

@maxrjones looks close I think the only thing missing is a copy of that notebook in the PR that goes into notebooks/templates ? open to other location ideas. I just don't want it to only exist in the shared folder on VEDA where it can go missing.

It's just two lines of code which are shown in the GIF. Also, only admins should be able to modify the shared-readwrite directory, so I think the risk here is minimal.

Relatedly, could you please create that notebook in shared-readwrite? I would offer to become an admin, but I actually think it's useful for me to have the same experience as a typical VEDA user.

@wildintellect do you think we could merge this PR? a Hub user is asking about sharing code and I think these instructions could be helpful

wildintellect commented 1 week ago

@maxrjones another reason to put it in the repo, this code will actually get checkout to instances and we won't need to manage shared-public/shared-rewrite.

maxrjones commented 1 week ago

@maxrjones another reason to put it in the repo, this code will actually get checkout to instances and we won't need to manage shared-public/shared-rewrite.

OK, done

review-notebook-app[bot] commented 1 week ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB