Skip to content

Commit

Permalink
generalize and include better hyperlinks for JupyterBook 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
aaarendt committed Mar 15, 2024
1 parent c616afe commit 577c534
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions book/projects/project_initialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,23 @@ Before getting started, you'll need a name for your project. A team exploring sn
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.
1. Go to: {{ '[https://github.com/`{hw}`](https://github.com/{hw})'.format(hw=hackweek) }}
1. Click the green “New” button on right side of page
1. Select the "{{hackweek}}/sample_project_repository" template
1. Use short project name
1. We recommend choosing "Public" (so other participants can follow progress). You can also select Private for now and make Public before final presentation.

* 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: {{ '[https://github.com/orgs/`{hw}`](https://github.com/orgs/{hw})'.format(hw=hackweek + "/teams") }} (or click the "Teams" tab near the top of the GitHub Organization page)
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"
Expand All @@ -38,4 +45,6 @@ GitHub teams provide a convenient way for you to set permissions on your project
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
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.

0 comments on commit 577c534

Please sign in to comment.