-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
recognition suggestions, update email contact
- Loading branch information
Showing
3 changed files
with
44 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,8 +18,7 @@ jb build docs | |
|
||
## Contact | ||
|
||
* [Anthony Arendt](mailto:[email protected]) | ||
* [Scott Henderson](mailto:[email protected]) | ||
* [email eScience](mailto:[email protected]) | ||
|
||
## License | ||
|
||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,67 +1,43 @@ | ||
# Recognizing Contributions | ||
|
||
There are a variety of ways that we would like to recognize community contributions to hackweeks. | ||
|
||
## Website Presence | ||
|
||
We invite all people who join us in organizing and hosting a hackweek to be included in our "Meet the team" section of each hackweek website. | ||
|
||
We use this YAML markdown template for each team member. | ||
|
||
``` | ||
- title: | ||
avatar: | ||
role: | ||
organizations: | ||
- name: | ||
url: | ||
- name: | ||
bio: | ||
expertise: | ||
- | ||
- | ||
social: | ||
- icon: github | ||
icon_pack: fab | ||
link: | ||
user_groups: | ||
- | ||
``` | ||
Here is an example of how the text you include in this template gets rendered on the website: | ||
|
||
```{image} ../../images/website-bio.jpg | ||
:alt: example of how to fill out website bio | ||
:width: 1100px | ||
:align: center | ||
``` | ||
|
||
**Notes:** | ||
```{warning} | ||
So that the website correctly interprets the YAML format we recommend using our template and not changing indent or spacing. | ||
``` | ||
- We encourage everyone to use their GitHub avatar as the source of their personal photograph. | ||
- Provide your GitHub username, together with the full url, for the `link` key under `social`. | ||
- Acceptable user groups (roles) can be found [here](https://escience.washington.edu/using-data-science/hackweeks/planning/hackweek-roles). | ||
|
||
### Uploading to the website | ||
|
||
To include your content on the website, follow [these instructions](https://github.com/uwhackweek/jupyterbook-template/blob/main/team/README.md). Because YAML is a simple human-readable text format, you can add your content directly in the GitHub interface. We provide screenshots below for a particular event in 2024: | ||
|
||
This is a link to the template file for a specific event page https://github.com/uwhackweek/event-page-2024/edit/main/team/template.yaml | ||
|
||
Note that we change the name and add our personal info | ||
|
||
|
||
<img width="1031" alt="Screen Shot 2022-06-07 at 3 07 21 PM" src="https://user-images.githubusercontent.com/3924836/172491535-8aa4d9ff-4d2d-492a-96ff-c8ba49c1b2e5.png"> | ||
|
||
It's best practice to create [pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) from 'feature' branches. So commit your changes on a branch other than the 'main' branch: | ||
<img width="1031" alt="Screen Shot 2022-06-07 at 3 08 02 PM" src="https://user-images.githubusercontent.com/3924836/172491617-ec81e180-2a61-4ed0-be28-65dff12559bd.png"> | ||
|
||
|
||
## Online Tutorials | ||
|
||
All of our tutorials are recorded and shared on the [eScience Institute's youtube channel](https://www.youtube.com/c/UWeScienceInstitute/playlists). We encourage tutorial leads to link to these videos from their social media accounts and websites as a way to demonstrate their teaching competencies. | ||
|
||
## Referrals and Feedback | ||
|
||
The eScience Institute's hackweek as a service program will provide references for past organizers upon request. We will also offer feedback to help promote your professional development. [Contact us](mailto:[email protected]) for more information. | ||
# Recognizing Contributions | ||
|
||
There are a variety of ways that we would like to recognize community contributions to hackweeks. | ||
|
||
## Website Presence | ||
|
||
We invite all people who join us in organizing and hosting a hackweek to be included in our "Meet the team" section of each hackweek website: | ||
|
||
```{image} ../../images/meet-the-team.png | ||
:alt: meet the team website section for bios | ||
:width: 1100px | ||
:align: center | ||
``` | ||
|
||
We use a YAML template to render this portion of the website. The arrows below map the template text to how it appears on the webs: | ||
|
||
```{image} ../../images/website-bio.jpg | ||
:alt: example of how to fill out website bio | ||
:width: 1100px | ||
:align: center | ||
``` | ||
|
||
**Notes:** | ||
```{warning} | ||
So that the website correctly interprets the YAML format we recommend using our template and not changing indent or spacing. | ||
``` | ||
- We encourage everyone to use their GitHub avatar as the source of their personal photograph (e.g. https://avatars.githubusercontent.com/USERNAME) | ||
- Also provide your GitHub username, together with the full url, for the `link` key under `social` (https://github.com/USERNAME) | ||
- Acceptable user groups (roles) can be found [here](https://escience.washington.edu/using-data-science/hackweeks/planning/hackweek-roles). | ||
|
||
### Uploading to the website | ||
|
||
To include your content on the website, follow [these instructions](https://github.com/uwhackweek/jupyterbook-template/blob/main/team/README.md). Because YAML is a simple human-readable text format, you can add your content directly in the GitHub interface. We provide screenshots below for a particular event in 2024: | ||
|
||
This is a link to the template file for a specific event page https://github.com/uwhackweek/event-page-2024/edit/main/team/template.yaml | ||
|
||
## Online Tutorials | ||
|
||
All of our tutorials are recorded and shared on the [eScience Institute's youtube channel](https://www.youtube.com/c/UWeScienceInstitute/playlists). We encourage tutorial leads to link to these videos from their social media accounts and websites as a way to demonstrate their teaching competencies. | ||
|
||
## Referrals and Feedback | ||
|
||
The eScience Institute's hackweek as a service program will provide references for past organizers upon request. We will also offer feedback to help promote your professional development. [Contact us](mailto:[email protected]) for more information. |