Skip to content

Commit

Permalink
Merge pull request #11 from czi-catalystproject/objectives
Browse files Browse the repository at this point in the history
Write lesson and episode objectives.
  • Loading branch information
jnywong authored Feb 1, 2024
2 parents 37b7ebb + 6bdebf4 commit 2ab197b
Showing 1 changed file with 69 additions and 10 deletions.
79 changes: 69 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,54 @@
# JupyterHub Administration to Empower Research Communities

This lesson teaches the fundamentals of JupyterHub administration and user support.
This lesson is aimed at Hub Champions and teaches the fundamentals of hub administration and user support for 2i2c managed JupyterHubs in the cloud. Delivered over two synchronous workshops, two hours in length a week apart. The time in between is dedicated to self-guided study with asynchronous support (via email 2i2c support / online Slack? To be discussed).

## Note
This lesson is under active development and not ready for teaching yet.
> [!WARNING]
> This lesson is under active development and not ready for teaching yet.
> [!INFO]
> TODO: Link to the Spanish repo.
## Lesson objectives

After attending this training, Hub Champions will be able to:

- explain how interactive cloud computing can empower your user community
- control user authentication and access to your hub
- monitor usage and cloud billing costs
- apply software environments through containerization
- navigate the filesystem and transfer data to and from the hub
- provide user support and troubleshoot common issues

## Episode objectives

1. :star: Recognising the benefits your hub can provide for your user community
- identify use cases of your user community
- distinguish which hub features can support these use cases
- understand your role and capacity as a Hub Champion to administer and support your hub
1. Administering your hub
- add users to the hub with GitHub
- configure server options (CPU, GPU, RAM)
- stop and restart a server
1. Applying software environments
- explain the value of reproducibility with containerized software environments
- pull a pre-configured Jupyter or RStudio image container for your hub
1. Navigating the filesystem and transferring data to and from the hub
- recognise and locate your home directory
- distribute datasets to all hub users in a shared directory
- push and pull GitHub repos with `gh-scoped-creds`
1. :star: Troubleshooting and providing user support
- triage common problems and know where to look for help
- share learning experiences from self-guided study
- foster a sustainable support system for your community

(:star: indicates this episode is delivered via a synchronous workshop)

## Prerequisites

Before joining the training, participants should be able to:

- access the 2i2c training hub
- login to their GitHub account

## Authors

Expand All @@ -12,11 +57,25 @@ This lesson is under active development and not ready for teaching yet.
- [James Munroe](https://github.com/jmunroe)
- [Jenny Wong](https://github.com/jnywong)

To Do:
## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md).

## License

See [LICENSE.md](./LICENSE.md)

## Acknowledgements and Funding

We would like to acknowledge Chan Zuckerberg Initiative funding for the "A Collaborative Interactive Computing Service Model for Global Communities" project and our partner organisations:

- [2i2c](https://2i2c.org/)
- [The Carpentries](https://carpentries.org/about/)
- [Center for Scientific Collaboration and Community Engagement](https://www.cscce.org/)
- [Invest in Open Infrastructure](https://investinopen.org/)
- [MetaDocencia](https://www.metadocencia.org/)
- [Open Life Science](https://openlifesci.org/)

## Contacting us

- motivation
- Catalyst Project
- acknowledgements and funding
- link to contributing file
- contact details
- link to the Spanish repo
If you would like to get in touch with us, then please email [[email protected]](mailto:[email protected]).

0 comments on commit 2ab197b

Please sign in to comment.