From d3a3a072115bcf0a6f9b0fd4dea06b7677c06d69 Mon Sep 17 00:00:00 2001 From: Scott Henderson Date: Fri, 28 Jun 2024 13:22:20 -0700 Subject: [PATCH 1/2] point to guidebook content --- book/_toc.yml | 4 -- book/projects/index.md | 37 +++++++++--------- book/projects/list_of_projects.md | 8 ---- book/projects/project_initialization.md | 50 ------------------------- book/projects/project_roadmap.md | 47 ----------------------- book/tutorials/index.md | 10 ++--- 6 files changed, 23 insertions(+), 133 deletions(-) delete mode 100644 book/projects/list_of_projects.md delete mode 100644 book/projects/project_initialization.md delete mode 100644 book/projects/project_roadmap.md diff --git a/book/_toc.yml b/book/_toc.yml index f427aa5c..336f608e 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -23,11 +23,7 @@ parts: - file: tutorials/example/tutorial-notebook - caption: Projects chapters: - - file: projects/list_of_projects - file: projects/index - sections: - - file: projects/project_roadmap - - file: projects/project_initialization - caption: Reference chapters: - file: reference/glossary diff --git a/book/projects/index.md b/book/projects/index.md index a6c60e8b..0b441362 100644 --- a/book/projects/index.md +++ b/book/projects/index.md @@ -1,17 +1,20 @@ -# Projects - -During hackweeks we invite participants to collaborate in small group project teams (usually 5-7 people). Projects provide unique opportunities for networking, advancing research and learning new things. - -We encourage you to be creative in how you design your project work! Here are some ways people have used project time in the past: - -* *focus on learning*: dive deeper into tutorial content and gain more hands on experience with new tools -* *focus on community building*: hackweeks bring people together for the first time and projects are used to build social fabric and foster open science -* *focus on research*: people often work to advance a research challenge using tools shared during the event. This often includes ongoing graduate and postgraduate investigations. -* *focus on creating new tools*: hackweeks often expose general community software needs. Projects can be the catalyst for new community libraries. - -```{image} ../img/projects-montage.png -:alt: picture of people interacting during hackweek project work -:class: bg-primary mb-1 -:width: 700px -:align: center -``` \ No newline at end of file +# Projects + +During hackweeks we invite participants to collaborate in small group project teams (usually 5-7 people). Projects provide unique opportunities for networking, advancing research and learning new things. + +```{image} ../img/projects-montage.png +:alt: picture of people interacting during hackweek project work +:class: bg-primary mb-1 +:width: 700px +:align: center +``` + +You can find our comprehensive guide for organizing projects before, during, and after a hackweek in our [Hackweek Guidebook](https://guidebook.hackweek.io/training/projects/index.html). Below you'll find a table keeping track of all project work done during this event: + +## List of Projects + +Here is our current list of project for our {{dates}} {{ hackweek }} hackweek: + +| Project Name (with link to GitHub repo) | Short Description | Project Lead(s) | +|:--------|:--------|:-----| +| [Snow-Extrapolation](https://github.com/geo-smart/Snow-Extrapolation) | Goal: Improve National Snow Model (NSM) prediction performance in the Sierra Nevada mountains through domain constraints and the exploration of different ML algorithms. | Ryan Johnson | diff --git a/book/projects/list_of_projects.md b/book/projects/list_of_projects.md deleted file mode 100644 index 48a395f5..00000000 --- a/book/projects/list_of_projects.md +++ /dev/null @@ -1,8 +0,0 @@ -# List of Projects - -Here is our current list of project for our {{dates}} {{ hackweek }} hackweek: - -| Project Name (with link to GitHub repo) | Short Description | Project Lead(s) | -|:--------|:--------|:-----| -| [Snow-Extrapolation](https://github.com/geo-smart/Snow-Extrapolation) | Goal: Improve National Snow Model (NSM) prediction performance in the Sierra Nevada mountains through domain constraints and the exploration of different ML algorithms. | Ryan Johnson | - diff --git a/book/projects/project_initialization.md b/book/projects/project_initialization.md deleted file mode 100644 index 98607b91..00000000 --- a/book/projects/project_initialization.md +++ /dev/null @@ -1,50 +0,0 @@ -# Project Initialization - -We encourage all teams to use Slack and GitHub to coordinate sharing of ideas, data and code. - -## Project Name - -Before getting started, you'll need a name for your project. A team exploring snow surface temperatures used the name "hot-pow", and one looking at ice-ocean interactions was called "floes-are-swell". Keep it short and memorable, and most of all, have fun! - -## Create a new Slack channel -1. Click “+” icon next to Channels list in Slack sidebar -> “Create a channel” -1. Use short project name -1. Invite your team members Slack members - -## Use our GitHub Project Template - -We have created a GitHub template that is pre-populated with directories and a README layout the we find works well with most teams. - -We encourage all teams to create a new GitHub repository within the {{hackweek}} Organization, even if it is just to point to an already-existing repository or package your team is contributing to for their project. - -* Go to: {{ '[https://github.com/{name}/sample_project_repository](https://github.com/{name}/sample_project_repository)'.format(name=hackweek) }} - -* Click the green "Use this template" button on right side of page: - -![new-repo-screenshot](../img/project-template.png) - -* Choose "Create a new repository" -* Name your repository using a short name. -* We recommend choosing "Public" (so other participants can follow progress). You can also select Private for now and make Public before final presentation. - -Visit the [GitHub documentation](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template) for more details on creating a repository from a template. - -## Create a new GitHub team within the {{hackweek}} Organization -GitHub teams provide a convenient way for you to set permissions on your project repository for groups of people, rather than having to do this for each individual on your team. - -1. Go to the "Teams" tab near the top of the GitHub {{hackweek}} Organization page: {{ '[https://github.com/orgs/{name}/teams](https://github.com/orgs/{name}/teams)'.format(name=hackweek) }} -1. Click green “New team” button -1. Use your short project name for "Team name" -1. Set the team to visibility "Visible" -1. Click on the "Create Team" button -1. Add all team members by clicking the “Members” tab and the green “Add a member” button - -### Add the project team to your project repo - -1. Go to the new repository you just created -1. Click “Settings” tab in upper right corner -1. Select “Manage access” on left side of page -1. Add your team name under the "Manage access" section -1. Select “write” to enable all team members to make commits - -Visit the [GitHub documentation](https://docs.github.com/en/organizations/organizing-members-into-teams/creating-a-team) for more details on creating a team. \ No newline at end of file diff --git a/book/projects/project_roadmap.md b/book/projects/project_roadmap.md deleted file mode 100644 index 8d842611..00000000 --- a/book/projects/project_roadmap.md +++ /dev/null @@ -1,47 +0,0 @@ -# Project Roadmap - -Each project will progress through these stages: - -```{image} ../img/project-timeline.png -:alt: flowchart of typical hackweek project timelines -:class: bg-primary mb-1 -:width: 800px -:align: center -``` - -## **Project Ideation and Team formation** - -### Weeks Before the Event - -We will form project teams in the month prior to the hackweek. As soon as you are accepted to the event we will invite you to Slack where you can begin exploring project ideas. Organizers will be available to answer questions and to help participants get connected with a project that fits their learning objectives. - - -### Day 1 of the Event - -We facilitate a project team formation session on the first day of the hackweek. During this time we will finalize project goals and objectives. Hackweek organizers and facilitators will help each team set reasonable goals and develop a roadmap for task completion. - -## **Teamwork** - -* kick-off meeting focuses on hearing from each team member: - * What are your unique learning goals? - * How do you work best? What level of group interaction works for you? - * What skills and background are you most excited to share with the team? - * When are you available to meet? -* set up team computing infrastructure on Slack and GitHub ([Project Initialization](project_initialization)) -* project work begins and teams have regular check-ins to chart progress -* project outputs are recorded in a GitHub repository - -## **Share-Out** - -* each team has 15 minutes to share what was learned, what challenges arose, what might be worth trying next -* individual contributions to the group effort are recognized and celebrated - -## **Communities of Practice** - -* We aspire to keep projects going after the hackweek! This is an optional (ideal) outcome of hackweek project work. -* Project leads/helpers will transition to longer-term engagement via mentorship role (optional/with support). -* Additional people join a growing Community of Practice (for example, centered on a community software library). -* software, research results are packaged and shared/published. - - - diff --git a/book/tutorials/index.md b/book/tutorials/index.md index 91402a62..576c1d13 100644 --- a/book/tutorials/index.md +++ b/book/tutorials/index.md @@ -1,12 +1,8 @@ # Tutorials -These tutorials consist of Jupyter Notebooks that can be run in our -{{ '[preconfigured software environment]({url})'.format(url=jupyterhub_url) }} -If you are attending the hackweek, you have access to a JupyterHub environment -with all the necessary Python software packages installed that are needed to run -through these tutorials interactively. On JupyterHub, your home directory persists -so any changes you make to the tutorials will be saved and be there for you next -time you log in. +Hackweek tutorials are learning-oriented and guide participants through a step-wise process with a meaningful outcome. If you are putting together a new tutorial for this event, refer to our [Hackweek Guidebook](https://guidebook.hackweek.io/training/tutorials/index.html). + +Below you'll find a table keeping track of all tutorials presented at this event: | Tutorial | Topics | Datasets | Recording Link | | - | - | - | - | From 2fdda9d1a6477da1a4ac84036c27ef77b60e3034 Mon Sep 17 00:00:00 2001 From: Scott Henderson Date: Fri, 28 Jun 2024 13:26:44 -0700 Subject: [PATCH 2/2] switch intro page link --- book/intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/intro.md b/book/intro.md index c29779db..074d6edc 100644 --- a/book/intro.md +++ b/book/intro.md @@ -5,7 +5,7 @@ 📖 On this JupyterBook website you'll find [tutorials](tutorials/index). All tutorials are Jupyter Notebooks, designed to be run interactively, but also rendered on this website for convenience. -👩‍💻 During a Hackweek teams work collaboratively on different projects. Read more about the projects and results on our [projects page](projects/list_of_projects) +👩‍💻 During a Hackweek teams work collaboratively on different projects. Read more about the projects and results on our [projects page](projects/index) 💡 Learn more about hackweeks hosted by the [University of Washington eScience Institute](https://uwhackweek.github.io/hackweeks-as-a-service/intro.html), or check out our publication describing the hackweek educational model {cite:p}`Huppenkothen2018`.