Refresh hackweek as a service Jupyter Book (#48)

* update: this is now a ref for the OT not website for new clients * remove content related to new clients * remove Jane add Mark * update JBook version * delete client related content * new updated image * delete old content * revert to JBook 0.13 * update description and fix conda env * initial commit of training docs * add references * clean up / delete files * change reference format * restructure table of contents * delete list of contributors * initial commit * initial commit * update
uwhackweek · Mar 27, 2024 · d4b7969 · d4b7969
1 parent a15ca3c
commit d4b7969
Show file tree

Hide file tree

Showing 65 changed files with 131 additions and 1,244 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 [![Deploy](https://github.com/uwhackweek/hackweeks-as-a-service/actions/workflows/deploy.yaml/badge.svg)](https://github.com/uwhackweek/hackweeks-as-a-service/actions/workflows/deploy.yaml)
 [![DOI](https://zenodo.org/badge/354072491.svg)](https://zenodo.org/badge/latestdoi/354072491)
 
-This repository hosts a website with information describing the [UW eScience Institute's](https://escience.washington.edu) hackweeks as a service model. It uses [Jupyter-book](https://jupyterbook.org/) and the website is hosted on the gh-pages branch.
+This repository hosts a website with information to support the Organizing Team of [UW eScience Institute's](https://escience.washington.edu) earth science focused hackweeks. It uses [Jupyter-book](https://jupyterbook.org/) and the website is hosted on the gh-pages branch.
 
 ## GitHub Deployment
 This repository is configured with [GitHub Actions](./.github/workflows/deploy.yaml) to automatically build and publish HTML to the gh-pages branch. Just commit to the main branch and the website will be automatically updated.
@@ -12,7 +12,7 @@ This repository is configured with [GitHub Actions](./.github/workflows/deploy.y
 git clone https://github.com/uwhackweek/hackweeks-as-a-service.git
 cd hackweeks-as-a-service
 conda env create
-conda activate hackweek
+conda activate hackweek-guidebook
 jb build docs
 ```
 

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -26,7 +26,7 @@ bibtex_bibfiles:
 
 sphinx:
   config:
-    bibtex_reference_style: author_year  # or label, super, \supercite
+    bibtex_reference_style: label  # or label, super, \supercite
 
 # Add GitHub buttons to your book
 # See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository

diff --git a/docs/_toc.yml b/docs/_toc.yml
@@ -3,40 +3,28 @@ root: intro
 parts:
 - caption: Overview
   chapters:
-    - file: mission
-    - file: team
-- caption: Hackweek Services
+    - file: overview
+- caption: Tutorial Design
   chapters:
-    - file: client
-    - file: services/index
+    - file: tutorials/index  
+      sections: 
+        - file: tutorials/tutorial-resources
+        - file: tutorials/tutorials
+- caption: Project Design
+  chapters:
+  - file: projects/index
+- caption: Accessible Technology
+  chapters:
+    - file: technology/index  
       sections:
-        - file: services/lead-eScience
-        - file: services/lead-community
-        - file: services/program-manager
-        - file: services/collaboration-architect
-        - file: services/budget-manager
-        - file: services/education-consultant
-        - file: services/tutorial-developer
-        - file: services/project-consultant
-        - file: services/project-lead
-        - file: services/technology-consultant
-        - file: services/helper
-    - file: application
-- caption: Resources for Organizers
+        - file: technology/data-management
+        - file: technology/recognition
+- caption: Strategy and Planning
   chapters:
-  - file: resources/index
-    sections:
-      - file: resources/tutorials
-      - file: resources/tutorial-resources
-      - file: resources/data-management
-      - file: resources/recognition
-- caption: Gallery
+    - file: strategy/index  
+- caption: Learning Culture
   chapters:
-  - file: gallery/index
-    sections:
-      - file: gallery/ICESat-2hackweek
-      - file: gallery/SnowExhackweek
-      - file: gallery/geohackweek
+    - file: culture/index 
 - caption: Reference
   chapters:
     - file: bibliography

diff --git a/docs/acknowledgements.md b/docs/acknowledgements.md
@@ -2,9 +2,6 @@
 
 Hackweeks were designed within the [Moore/Sloan Data Science Environment](http://msdse.org/), and borrow ideas from [The Carpentries](https://carpentries.org/). Early design of hackweeks occurred within previous events including [astrohackweek](http://astrohackweek.org) led by [Daniela Huppenkothen](https://huppenkothen.org/) and [Jake VanderPlas](http://vanderplas.com/) and [neurohackademy](https://neurohackademy.org) led by [Ariel Rokem](https://arokem.org/). The model was further developed within a series of earth science related hackweeks including [geohackweek](https://geohackweek.github.io), [waterhackweek](https://waterhackweek.github.io), [oceanhackweek](https://oceanhackweek.github.io) and [Cryospheric Sciences with ICESat-2 hackweek](https://icesat-2hackweek.github.io). 
 
-Key contributors to the design of our earth science hackweeks include (in alphabetical order) [Christina Bandaragoda](https://escience.washington.edu/people/christina-bandaragoda/), [Nicoleta Cristea](https://freshwater.uw.edu/person/nicoleta-cristea/), [Charley Haley](https://www.linkedin.com/in/pamhaley/#), [Lindsey Heagy](https://www.eoas.ubc.ca/people/lindseyheagy), [Scott Henderson](https://www.ess.washington.edu/people/profile.php?pid=henderson--scott), [Friedrich Knuth](https://github.com/friedrichknuth), [Jane Koh](https://escience.washington.edu/people/jane-koh/), [Catherine Kuhn](http://ecosystembiogeochemistry.org/catherine-kuhn), [Emilio Mayorga](https://www.apl.washington.edu/people/profile.php?last_name=Mayorga&first_name=Emilio), [Joachim Meyer](https://github.com/jomey), [Fernando Pérez](https://bids.berkeley.edu/people/fernando-p%C3%A9rez), [Axel Schweiger](https://apl.uw.edu/people/profile.php?last_name=Schweiger&first_name=Axel), [Landung Setiawan](https://www.ocean.washington.edu/home/Don_Setiawan), [Jessica Scheick](https://eos.unh.edu/person/jessica-scheick), [David Shean](https://dshean.github.io/), [Amanda Tan](https://www.linkedin.com/in/atanlehr/) and many others!
-
-
 ## Funding Sources
 
 Hackweeks have evolved due to generous funding from the Gordon and Betty Moore Foundation, the Alfred P. Sloan foundation, and a grant from the Washington Research Foundation.

diff --git a/docs/application.md b/docs/application.md
diff --git a/docs/client.md b/docs/client.md
diff --git a/docs/culture/index.md b/docs/culture/index.md
@@ -0,0 +1,3 @@
+# Introduction
+
+We strive to create a sense of belonging by meeting participants where they are and embracing the idea that each of us is on a lifelong journey of learning.
diff --git a/docs/gallery/ICESat-2hackweek.md b/docs/gallery/ICESat-2hackweek.md
diff --git a/docs/gallery/SnowExhackweek.md b/docs/gallery/SnowExhackweek.md
diff --git a/docs/gallery/geohackweek.md b/docs/gallery/geohackweek.md
diff --git a/docs/gallery/index.md b/docs/gallery/index.md
diff --git a/docs/images/CoC.png b/docs/images/CoC.png
diff --git a/docs/images/ICESat-2hackweek-impacts-2020.png b/docs/images/ICESat-2hackweek-impacts-2020.png
diff --git a/docs/images/ICESat-2hackweek-tutorial-eval-2020.png b/docs/images/ICESat-2hackweek-tutorial-eval-2020.png
diff --git a/docs/images/SnowExhackweek-impacts-2021.png b/docs/images/SnowExhackweek-impacts-2021.png
diff --git a/docs/images/SnowExhackweek-tutorial-eval-2021.png b/docs/images/SnowExhackweek-tutorial-eval-2021.png
diff --git a/docs/images/belonging.png b/docs/images/belonging.png
diff --git a/docs/images/co-creation.png b/docs/images/co-creation.png
diff --git a/docs/images/community-roles-time-commitment.png b/docs/images/community-roles-time-commitment.png
diff --git a/docs/images/education-collage1.png b/docs/images/education-collage1.png
diff --git a/docs/images/education-collage2.png b/docs/images/education-collage2.png
diff --git a/docs/images/education.png b/docs/images/education.png
diff --git a/docs/images/geohackweek-2019.png b/docs/images/geohackweek-2019.png
diff --git a/docs/images/hackweeks.png b/docs/images/hackweeks.png
diff --git a/docs/images/interactivity.png b/docs/images/interactivity.png
diff --git a/docs/images/lead-eScience-collage1.png b/docs/images/lead-eScience-collage1.png
diff --git a/docs/images/lead-eScience-collage2.png b/docs/images/lead-eScience-collage2.png
diff --git a/docs/images/lead-eScience-collage3.png b/docs/images/lead-eScience-collage3.png
diff --git a/docs/images/networking.png b/docs/images/networking.png
diff --git a/docs/images/noun-help-5401808-gold.png b/docs/images/noun-help-5401808-gold.png
diff --git a/docs/images/noun-help-5401808.png b/docs/images/noun-help-5401808.png
diff --git a/docs/images/noun-project-management-1874172-gold.png b/docs/images/noun-project-management-1874172-gold.png
diff --git a/docs/images/noun-project-management-1874172.png b/docs/images/noun-project-management-1874172.png
diff --git a/docs/images/noun-teach-1614348-gold.png b/docs/images/noun-teach-1614348-gold.png
diff --git a/docs/images/noun-teach-1614348.png b/docs/images/noun-teach-1614348.png
diff --git a/docs/images/noun-teamwork-1616304-gold.png b/docs/images/noun-teamwork-1616304-gold.png
diff --git a/docs/images/noun-teamwork-1616304.png b/docs/images/noun-teamwork-1616304.png
diff --git a/docs/images/projects.png b/docs/images/projects.png
diff --git a/docs/images/roles-graphic.png b/docs/images/roles-graphic.png
diff --git a/docs/intro.md b/docs/intro.md
@@ -1,47 +1,14 @@
-Hosting a Hackweek with UW eScience Support
-===========================================
+Resources for Organizing a Hackweek
+===================================
 
-<font size="4"> Hackweeks are participant-driven events that strive to create welcoming spaces for participants to learn new things, build community and gain hands-on experience with collaboration and team science {cite:p}`Huppenkothen2018`</font>
+<font size="4"> Hackweeks are participant-driven events that strive to create welcoming spaces for participants to learn new things, build community and gain hands-on experience with collaboration and team science {cite:p}`Huppenkothen2018`.</font>
 
-<font size="4"> The University of Washington's [eScience Institute](https://escience.washington.edu/) is interested in partnering with your organization to offer our hackweek model as a service. We can provide administrative, technical and educational support to facilitate hackweeks for your community.</font>
-
-## Here are a few links to get you started!
-
-::::{grid}
-
-:::{grid-item-card}
-:class-header: grid-card-purple
-**<span style='color:white'> What is a hackweek? </span>**
-^^^
-Learn more about the hackweek model at our [Hackweek Mission](mission) page.
-
-Get to know [our team](team) of hackweek designers and supports.
-
-Browse the [services](services/index) we can provide.
-:::
-
-:::{grid-item-card}
-:class-header: grid-card-purple
-**<span style='color:white'> Application Procedure </span>**
-^^^
-Are you interested in working with us? Review a list of [minimum requirements](client) for hosting a hackweek.
-
-Next, [submit an application](application)!
-:::
-
-:::{grid-item-card}
-:class-header: grid-card-purple
-**<span style='color:white'> Be inspired </span>**
-^^^
-Visit our [Gallery](gallery/index) of past supported hackweeks.
-:::
-
-::::
+<font size="4"> This website provides reference material and training modules to support organizers of earth science themed hackweeks hosted in partnership with The University of Washington's [eScience Institute](https://escience.washington.edu/using-data-science/hackweeks/).</font>
 
 
 ```{image} images/hackweeks.png
-:alt: Moore Foundation logo
+:alt: picture of ICESat-2 hackweek participants
 :class: bg-primary mb-1
-:width: 2500px
+:width: 500px
 :align: center
 ```
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Introduction

		We strive to create a sense of belonging by meeting participants where they are and embracing the idea that each of us is on a lifelong journey of learning.