Skip to content

Commit

Permalink
Merge pull request #7 from snowex-hackweek/chore/template_sync_5893fa3
Browse files Browse the repository at this point in the history
upstream merge template repository
  • Loading branch information
jomey authored Aug 1, 2024
2 parents 4bd9475 + c498cb6 commit 53fb1ce
Show file tree
Hide file tree
Showing 25 changed files with 179 additions and 166 deletions.
6 changes: 6 additions & 0 deletions .templatesyncignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,11 @@ team/*-*
###
# book files (configuration, usage-specific)
book/_config.yml
book/logo.png
###
# event-specific tutorials
###
# files you may want to exclude once you start using your template
.gitignore
README.md
book/_toc.yml
47 changes: 22 additions & 25 deletions book/CoC.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,39 @@
# Event Code of Conduct
# Participant Conduct

Guidelines to ensure we offer a hospitable and inclusive event and a list of resources for reporting violations. Although the content is similar, this event Code of Conduct should not be confused with the {{ '[Contributor Covenant Code of Conduct]({url}/{repo}/blob/main/CODE_OF_CONDUCT.md)'.format(url=github_org_url, repo=book_repo) }} governing contributions to this JupyterBook.
We require all participants in the University of Washington (UW) eScience Hackweek program to comply with the [eScience Code of Conduct](https://escience.washington.edu/about/code-of-conduct/) copied below.

Hackweek participants are intentionally diverse across many categories including academic standing, domain field, technical experience, etc., and we expect everyone to respect all perspectives represented. Please also read the [eScience Equity Statement](https://escience.washington.edu/about/equity-statement/).

---
## Code of Conduct

## Overview
The University of Washington eScience Institute (“eScience”) is dedicated to providing a welcoming, supportive and inclusive environment for all people, regardless of background and identity. We do not tolerate discrimination or harassment based on characteristics that include, but are not limited to gender, gender identity and expression, sexual orientation, marital status, disability, physical appearance, body size, race, age, national origin or religion. Any form of behavior to exclude, intimidate, or cause discomfort is a violation of the Code of Conduct. By participating in this community, participants accept to abide by the eScience Code of Conduct and accept the procedures by which any Code of Conduct incidents are resolved.

The organizers of this event are dedicated to providing a harassment-free learning experience for everyone regardless of gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, ethnicity, age or religion.
We do not tolerate harassment of participants in any form. Sexual language and imagery is not appropriate for any event venues in either in-person or virtual form, including the Slack workspace. Participants (including event volunteers and organizers) violating these rules may be sanctioned or expelled from the {{hackweek}} at the discretion of the organizers.
In order to foster a positive and professional learning environment we encourage the following kinds of behaviors on all platforms and during all events, both in-person and online:

## Definition of Harassment
* Use welcoming and inclusive language
* Be respectful of different viewpoints and experiences
* Gracefully provide and accept constructive criticism
* Show courtesy and respect towards other community members

Harassment includes, but is not limited to:

* Verbal comments that reinforce social structures of domination related to gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, ethnicity, age, religion.
* Sexual images in public spaces
* Written or verbal comments that reinforce social structures of domination related to gender, gender identity and expression, sexual orientation, marital status, disability, physical appearance, body size, race, age, national origin or religion
* Violent threats or language directed against another person
* Sexual language or images in public spaces
* Deliberate intimidation, stalking, or following
* Harassing photography or recording
* Sustained disruption of talks or other events
* Inappropriate physical contact
* Unwelcome sexual attention
* Continuing to initiate interaction (including photography or recording) after being asked to stop
* Publication of private communication without consent
* Sustained disruption of talks, events, or communications
* Insults or put downs
* Nonconsensual or unwelcome physical contact
* Advocating for, or encouraging, any of the above behavior

## Expectations
Participants asked to stop any harassing behavior are expected to comply immediately. This applies to any eScience events or activities, either online or in-person. Participants violating these rules may be sanctioned or expelled from participation at the discretion of eScience staff. The organizers may take action to redress anything designed to, or with the clear impact of, disrupting the event or making the environment hostile for any participants. 

We expect participants and instructors to act in ways that foster a supportive and welcoming learning community at all event venues and event-related social activities. We expect you to support collaboration and learning while participating in this community of practice. Hackweek organizers may take action to redress anything designed to, or with the clear impact of, disrupting the event or making the environment hostile for any participants (including unintentionally). Participants asked to stop any harassing behavior are expected to comply immediately. Failure to comply may result in the participant being expelled from the event at the discretion of the organizers.
Harassment and other code of conduct violations reduce the value of our programming for everyone. If someone makes you or anyone else feel unsafe or unwelcome, please report it as soon as possible. You can make a report either personally or anonymously. To personally report, contact the eScience executive director, Sarah Stone, at [email protected] or another trusted staff member. Anonymous reports can be made [here](https://bit.ly/uwhackweekfeedback). If you are experiencing a problem or issue that needs to be addressed by someone outside the program, you may contact the UW Office of the Ombud at [email protected] or 206-543-6028.

## Reporting a violation
Harassment and other code of conduct violations reduce the value of the event for everyone. If someone makes you or anyone else feel unsafe or unwelcome, please report it as soon as possible.
[SafeCampus](https://www.washington.edu/safecampus/) (206-685-7233) is also available at any time to anonymously discuss safety and well-being concerns for yourself and others. SafeCampus is the University of Washington’s violence-prevention and response program, providing resources to UW students, staff, faculty and community members. For more information, visit their [What to Expect](https://www.washington.edu/safecampus/what-to-expect) page.

If you feel comfortable contacting someone associated with our event, you may speak with one of the event organizers in person, send an e-mail to {{ '[`{email}`](mailto:{email})'.format(email=contact_email) }}, or contact an organizer on a private Slack channel. You may also submit an anonymous comment to our {{ '[virtual comment box]({url})'.format(url=anon_reporting_url) }}.
Thank you for helping to make our institute inclusive, welcoming and safe.

If you have experienced or observed harassment, unethical or unprofessional behavior as described above (a violation of this code of conduct) and want to talk to someone not directly associated with our event about it, choose from these specialists below:

* Contact the Office of the Ombud, 206-543-6028, [email protected], [www.uw.edu/ombud](https://www.uw.edu/ombud). For individuals who are uncertain about whether they want to pursue a formal complaint but would like to speak to someone about unethical or unprofessional behavior or some other challenging situations, the Ombud office provides a confidential, informal, and neutral resource for you. They can assist you with determining what, if any, course of action you would like to pursue and to navigate the different resources on campus.
* Speak up about discrimination to the University Complaint Investigation and Resolution Office (UCIRO), 206- 616-2028, [email protected]. Staff are available if you would like to file a formal complaint regarding discrimination.
* Speak up about sexual misconduct to the Title IX Office, 206-616-5334, [email protected], [link](https://www.washington.edu/compliance/tixio/). Staff are available if you would like to file a formal complaint regarding sexual misconduct.


This anti-harassment policy is based on the example policy from the Geek Feminism wiki, created by the Ada Initiative and other volunteers.
1 change: 1 addition & 0 deletions book/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ parse:
slack_workspace_url: "https://2024-uw-hackweek.slack.com"
contact_email: "[email protected]"
anon_reporting_url: "https://INSERT_FORM_LINK"
project_spreadsheet_url: "https://INSERT_GOOGLE_SHEET"
myst_enable_extensions:
# Defaults
- dollarmath
Expand Down
4 changes: 0 additions & 4 deletions book/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,7 @@ parts:
- file: tutorials/albedo/aviris-ng-data
- 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
Expand Down
4 changes: 2 additions & 2 deletions book/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

📖 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`.

```{admonition} Quick links for the event
:class: seealso
* JupyterHub: {{ jupyterhub_url }}
* GitHub organization: {{ github_org_url}}
* [List of projects](projects/list_of_projects)
* Projects Spreadsheet: {{ project_spreadsheet_url }}
```
37 changes: 20 additions & 17 deletions book/projects/index.md
Original file line number Diff line number Diff line change
@@ -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
```
# 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) |
|:--------|:--------|:-----|
| Sample Title | Sample Description | Leader |
8 changes: 0 additions & 8 deletions book/projects/list_of_projects.md

This file was deleted.

50 changes: 0 additions & 50 deletions book/projects/project_initialization.md

This file was deleted.

47 changes: 0 additions & 47 deletions book/projects/project_roadmap.md

This file was deleted.

10 changes: 3 additions & 7 deletions book/tutorials/index.md
Original file line number Diff line number Diff line change
@@ -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 |
| - | - | - | - |
Expand Down
7 changes: 7 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Recommended Additional Configuration

Some template features require additional GitHub settings. For example, the [netlifypreview.yaml](.github/workflows/netlifypreview.yaml) workflow requires a [netlify account](https://www.netlify.com) and configuring Netlify and GitHub to work together

[github-setup.md](./github-setup.md): Our recommendations for configuring a GitHub organization and managing secrets for a Hackweek

[netlify-setup.md](./netlify-setup.md): Documentation on setting up previews of website changes in pull requests with Netlify
Loading

0 comments on commit 53fb1ce

Please sign in to comment.