diff --git a/.templatesyncignore b/.templatesyncignore index ddb9ac7..f4e7498 100644 --- a/.templatesyncignore +++ b/.templatesyncignore @@ -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 \ No newline at end of file diff --git a/book/CoC.md b/book/CoC.md index b5e0757..c506457 100644 --- a/book/CoC.md +++ b/book/CoC.md @@ -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 sstone3@uw.edu 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 ombuds@uw.edu 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, ombuds@uw.edu, [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, uciro@uw.edu. 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, tixinv@uw.edu, [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. diff --git a/book/_config.yml b/book/_config.yml index 068337b..e60a805 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -17,6 +17,7 @@ parse: slack_workspace_url: "https://2024-uw-hackweek.slack.com" contact_email: "escience-hackweeks@uw.edu" anon_reporting_url: "https://INSERT_FORM_LINK" + project_spreadsheet_url: "https://INSERT_GOOGLE_SHEET" myst_enable_extensions: # Defaults - dollarmath diff --git a/book/_toc.yml b/book/_toc.yml index e83e9e7..142c129 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -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 diff --git a/book/intro.md b/book/intro.md index bb98497..074d6ed 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`. @@ -13,5 +13,5 @@ :class: seealso * JupyterHub: {{ jupyterhub_url }} * GitHub organization: {{ github_org_url}} -* [List of projects](projects/list_of_projects) +* Projects Spreadsheet: {{ project_spreadsheet_url }} ``` diff --git a/book/projects/index.md b/book/projects/index.md index a6c60e8..e36284a 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) | +|:--------|:--------|:-----| +| Sample Title | Sample Description | Leader | diff --git a/book/projects/list_of_projects.md b/book/projects/list_of_projects.md deleted file mode 100644 index 48a395f..0000000 --- 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 98607b9..0000000 --- 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 8d84261..0000000 --- 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 91402a6..576c1d1 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 | | - | - | - | - | diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..2eb08cb --- /dev/null +++ b/docs/README.md @@ -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 \ No newline at end of file diff --git a/docs/github-setup.md b/docs/github-setup.md new file mode 100644 index 0000000..04db60f --- /dev/null +++ b/docs/github-setup.md @@ -0,0 +1,27 @@ +# GitHub Setup + +## GitHub Organization + +We recommend that each hackweek creates a [GitHub Organization](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/about-organizations) to manage various repositories for an event. This makes organizing teams of users easy and consolidates content such as project work and tutorials for easier discoverability. It also allows managing secrets and making them available to different repositories if necessary. + +## Hackweek Bots + +For NASA-focused hackweeks we created a "bot" user with a Gmail account, GitHub Account https://github.com/hackweek-admin, and NASA Earthdata login (https://urs.earthdata.nasa.gov) to allow GitHub Actions workflows to access NASA Data with a set of credentials that do not belong to any individual. + +## GitHub Actions Secrets + +We can add credentials as ["Organization Secrets"](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) and make them available to only select repositories that need them. For example see the screenshots below on giving the `EARTHDATA_PASS` secret to a specific repository + +1. ### Repository secrets are under `Settings` -> `Secrets and variables` + + For example, replace `snowex-hackweek/website-2024` for your repository in the following URL: https://github.com/snowex-hackweek/website-2024/settings/secrets/actions + + **only people with `admin` access to a repository can access these settings** + + ![Repo secrets](./images/github-repo-secrets.png) + +1. ### Select `Manage organization secrets`. + + You can either create a new one, or click the "pencil" icon of an existing one to give access to a new repository + + ![Org Secrets](./images/github-org-secrets-list.png) \ No newline at end of file diff --git a/docs/images/github-org-secrets-list.png b/docs/images/github-org-secrets-list.png new file mode 100644 index 0000000..04902ce Binary files /dev/null and b/docs/images/github-org-secrets-list.png differ diff --git a/docs/images/github-repo-secrets.png b/docs/images/github-repo-secrets.png new file mode 100644 index 0000000..03158f8 Binary files /dev/null and b/docs/images/github-repo-secrets.png differ diff --git a/docs/images/github-repo-secrets2.png b/docs/images/github-repo-secrets2.png new file mode 100644 index 0000000..9487753 Binary files /dev/null and b/docs/images/github-repo-secrets2.png differ diff --git a/docs/images/netlify-addsite.png b/docs/images/netlify-addsite.png new file mode 100644 index 0000000..3a9fcdc Binary files /dev/null and b/docs/images/netlify-addsite.png differ diff --git a/docs/images/netlify-auth-token.png b/docs/images/netlify-auth-token.png new file mode 100644 index 0000000..151ea94 Binary files /dev/null and b/docs/images/netlify-auth-token.png differ diff --git a/docs/images/netlify-install-github-app.png b/docs/images/netlify-install-github-app.png new file mode 100644 index 0000000..4dbf26a Binary files /dev/null and b/docs/images/netlify-install-github-app.png differ diff --git a/docs/images/netlify-link-github.png b/docs/images/netlify-link-github.png new file mode 100644 index 0000000..13c16d7 Binary files /dev/null and b/docs/images/netlify-link-github.png differ diff --git a/docs/images/netlify-repo-access.png b/docs/images/netlify-repo-access.png new file mode 100644 index 0000000..f74237d Binary files /dev/null and b/docs/images/netlify-repo-access.png differ diff --git a/docs/images/netlify-select-org.png b/docs/images/netlify-select-org.png new file mode 100644 index 0000000..ebeac4f Binary files /dev/null and b/docs/images/netlify-select-org.png differ diff --git a/docs/images/netlify-select-repo.png b/docs/images/netlify-select-repo.png new file mode 100644 index 0000000..f29166f Binary files /dev/null and b/docs/images/netlify-select-repo.png differ diff --git a/docs/images/netlify-stop-builds.png b/docs/images/netlify-stop-builds.png new file mode 100644 index 0000000..315dc14 Binary files /dev/null and b/docs/images/netlify-stop-builds.png differ diff --git a/docs/netlify-setup.md b/docs/netlify-setup.md new file mode 100644 index 0000000..3a8fe20 --- /dev/null +++ b/docs/netlify-setup.md @@ -0,0 +1,80 @@ +# Configuring Netlify for pull request previews + +Public websites for hackweeks have content contributed by many different people, and we want to ensure that they are well-formatted and functional at all times. In order to do this, we "preview" changes to a website to confirm it all looks good before merging new content. There are different ways to accomplish this, but we have found that [Netlify](https://www.netlify.com) is free and works well for previews. + +## Link Netlify to a repository + +Netlify organizes websites by "Site" which is tied to a specific GitHub repository. *All preview links created are persistent and public but not indexed by search engines.* If you want to delete them, you can delete the 'Site' from Netlify. Importantly, the Netlify previews are completely decoupled from the main website that is hosted by GitHub Pages, so you do not need to worry about overwriting or losing your main event webpage! + +1. ### Make sure the Netlify App is installed for your organization + + Go to https://github.com/apps/netlify/installations/select_target or visit GitHub Org settings for GitHub Apps (e.g. https://github.com/organizations/snowex-hackweek/settings/installations): + + ![Add Site](./images/netlify-install-github-app.png) + + Under 'Configure' for Netlify you can select which repositories Netlify has access to: + + ![Add Site](./images/netlify-repo-access.png) + +1. ### Log into Netlify and 'Add new site' + + ![Add Site](./images/netlify-addsite.png) + +1. ### Select import an existing project + +image + +1. ### Select deploy project with GitHub + + ![Link GitHub](./images/netlify-link-github.png) + +1. ### Select correct GitHub Organization for website repo + + ![Select org](./images/netlify-select-org.png) + +1. ### Select correct repository based on this template (e.g. website-2024) + + ![Select repo](./images/netlify-select-repo.png) + + For 'Site name' enter something informative like `snowex-website-2024` and click 'Deploy' + +1. ### Disable netlify main deployment + + Important!! We only want to use Netlify for *Previews* so under 'Site Configuration' -> 'Build & Deploy' -> 'Continuous deployment' -> 'Build settings' -> 'Configure' -> select "Stopped Builds" -> Save + (e.g. https://app.netlify.com/sites/snowex-website-2024/configuration/deploys) + + If you do not do this, you will have a public mirror of your website available at your netlify site name (https://snowex-website-2024.netlify.app) + + ![Disable builds](./images/netlify-stop-builds.png) + +1. ### Copy unique NETLIFY_SITE_ID to use in GitHub Actions Workflows + + Copy the "Site ID" token string under "Site Details", it will look something like this "f9235abc-688d-45e4-8f62-5519ghi455j1" + + (e.g. https://app.netlify.com/sites/snowex-website-2024/configuration/general) + +1. ### Create a NETLIFY_AUTH_TOKEN to use in GitHub Actions workflows + + Go to https://app.netlify.com/user/applications and under 'Personal access token' create a new token with optional expiration. It will look something like this `nfp_8abcUxd2ESPs9yEegb3ATSBst13JicvY135s` + + ![Auth token](./images/netlify-auth-token.png) + + +1. ### Add GitHub Action Secrets to your repository + + In the end, a website repository needs to have access to both `NETLIFY_AUTH_TOKEN` and a specific `NETLIFY_SITE_ID` for the preview workflow to function: + + ![Repo secrets final](./images/github-repo-secrets2.png) + + In your website repository, go to 'Settings' -> 'Secrets and variables' -> 'Actions' -> 'New repository secret' . Make one for `NETLIFY_SITE_ID` and `NETLIFY_AUTH_TOKEN` with the codes copied in the previous two steps. + +1. ### Ensure that the workflow has permission to write issue comments + + image + + In your website repository, go to 'Settings' -> 'Actions' -> 'General' and scroll to the section on workflow permissions. Make sure sure that the workflow has read/write permissions. By default, this will be disabled at the organization level, so if the read/write is greyed out, you will need to have a GitHub organization admin change the org level permissions. To do this, go to the GitHub organization then 'Settings' -> 'Actions' -> 'General' and scroll to the section on workflow permissions. + +1. ### Trigger your first deploy + + Edit a file in GitHub, Commit and create a pull-request. Label the pull request 'preview'. You will need to create the 'preview' label the first time. Once you create the PR with label 'preview', the Netlify workflow will be triggers and when finished a link to a preview of the website will appear in the PR comments. + diff --git a/team/README.md b/team/README.md index 39cb9db..1975d3a 100644 --- a/team/README.md +++ b/team/README.md @@ -1,16 +1,21 @@ # The team folder -All members of the organizing team should add themselves to the webpage and -this folder contains a file for each person describing themselves. +All members of the organizing team should add themselves to the webpage. +This folder contains a file for each person describing themselves. ## Adding a new member Follow these steps to add yourself: -* Use the provided 'template.yaml' file and copy the file. -* Create a copy of the 'template.yaml' file and rename the file to your name +* Navigate to the 'landing page' repository for your event. +* Navigate into the 'teams' directory. +* Use the provided 'template.yaml' file. +* Create a copy of the 'template.yaml' file and rename the file to your name. +In the GitHub interface, you can create a new file and copy-paste from the template. +Or, in a local repository you can do this on the command line with ``` cp template.yaml FirstName-LastName.yaml ``` * Open the new file you just created in your favorite editor and fill out the details, replacing the placeholder text. -* Commit the file and open a pull request -* Don't forget to add a reviewer to the pull request so they get notified. +* Commit the file and (if necessary) push your changes to GitHub. +* Open a pull request (PR). +* Don't forget to add a reviewer to the PR so they get notified. \ No newline at end of file