Open Source Comes to Campus/Curriculum/Git/Organizer: Difference between revisions

Content added Content deleted

Inline

Latest revision as of 04:12, 2 March 2015

There's a bit of work which needs to be done ahead of time to set up this activity.

Optional: Customize

Optionally customize site

Customize the site in the repository github-website-editing-demo. If you do not have admin access to it, you can submit changes as a pull request. There are different versions to play with in different branches - if you're not familiar with branching, ask in #openhatch for help. (You'll probably want to talk to Shauna and/or Asheesh before submitting a pull request anyway.)

Optionally create/check issues

Customize the issues in the issue tracker, as needed. Make sure the issues in the issue tracker match the current version of the site.

Required: Set up organizations & repositories & tooling

Step 1: Create organizations

Create organizations for each project. We typically title this hostname-#, i.e. morris-1, morris-2, morris-3, princeton-1, princeton-2, princeton-3. While doing this, you can grant administrative privileges to anyone you know will need them.

Step 2: Download the tool

On your own computer, do:

  $ cd ~/Desktop
  $ git clone https://github.com/openhatch/open-source-comes-to-campus

Then use cd to change into the scripts directory, which is where we'll do the remaining operations.

  $ cd scripts

Step 3: Set up & use the tool

Read & follow the scripts setup instructions here: https://github.com/openhatch/open-source-comes-to-campus/tree/master/scripts

Get to the end of the README. That's essential before you continue!

Step 4: Prep instructors

Before you do the activity, you should have a list of mentors and assign them to an organization. You should:

Print out N copies (N being the number of repositories you made) of the Instructor handout

On each copy, write the name of one organization, for example schoolname-3

For each instructor, ask them their GitHub username, and add them as an owner of one organization on GitHub.

Hand that instructor the piece of paper corresponding to the specific organization you made them an owner of!

Make sure they click the invitation email so that they are truly added. If they don't do this, they will end up totally confused.

Although it's not necessary, we recommend finding out which instructors feel most comfortable with git ahead of time. You can ask if there are any attendees who already know the basics and want to learn more advanced material, and put them in groups with the more expert git instructors.

That should be it! If you run into any problems, ask on #openhatch.

@@ Line 2: / Line 2: @@
 There's a bit of work which needs to be done ahead of time to set up this activity.
-===Step 1: Customize site===
+== Optional: Customize ==
+===Optionally customize site===
 Customize the site in the repository [https://github.com/openhatch/github-website-editing-demo github-website-editing-demo].  If you do not have admin access to it, you can submit changes as a pull request.  There are different versions to play with in different branches - if you're not familiar with branching, ask in #openhatch for help.  (You'll probably want to talk to Shauna and/or Asheesh before submitting a pull request anyway.)
-===Step 2: Create/check issues===
+=== Optionally create/check issues===
 Customize the issues in the issue tracker, as needed.  Make sure the issues in the issue tracker match the current version of the site.
-===Step 3: Create organizations===
+== Required: Set up organizations & repositories & tooling ==
+===Step 1: Create organizations===
 Create organizations for each project.  We typically title this hostname-#, i.e. morris-1, morris-2, morris-3, princeton-1, princeton-2, princeton-3.  While doing this, you can grant administrative privileges to anyone you know will need them.
-===Step 4: Run setup.py===
+===Step 2: Download the tool ===
+On your own computer, do:
+   $ cd ~/Desktop
+   $ git clone https://github.com/openhatch/open-source-comes-to-campus
+Then use ''cd'' to change into the ''scripts'' directory, which is where we'll do the remaining operations.
+   $ cd scripts
+=== Step 3: Set up & use the tool ===
+Read & follow the ''scripts'' setup instructions here: https://github.com/openhatch/open-source-comes-to-campus/tree/master/scripts
+Get to the end of the README. That's '''essential''' before you continue!
+===Step 4: Prep instructors===
+Before you do the activity, you should have a list of mentors and assign them to an organization.  You should:
+* Print out N copies (N being the number of repositories you made) of the '''Instructor handout'''
+* On each copy, write the '''name of one organization''', for example ''schoolname-3''
+* For each instructor, ask them their GitHub username, and add them as an '''owner''' of one organization on GitHub.
-Run setup.py, found in [https://github.com/openhatch/open-source-comes-to-campus/tree/master/scripts OpenHatch's repository open-source-comes-to-campus, in the folder scripts].
+* Hand that instructor the piece of paper corresponding to the specific organization you made them an owner of!
-===Step 5: Prep instructors===
+* Make sure they click the invitation email so that they are truly added. If they don't do this, they will end up totally confused.
-Before you do the activity, you should have a list of mentors and assign them to an organization.  Make sure each instructor is a) given admin privileges for their organization and b) knows which organization they'll be using for their activity.  You'll need to get instructors' github usernames in order to do A.
 Although it's not necessary, we recommend finding out which instructors feel most comfortable with git ahead of time.  You can ask if there are any attendees who already know the basics and want to learn more advanced material, and put them in groups with the more expert git instructors.