Difference between revisions of "New Member Orientation"

From Earlham CS Department
Jump to navigation Jump to search
(Workspaces)
Line 1: Line 1:
Read what you need or want; you can always come back.
+
Welcome to the Earlham CS Department!
 +
 
 +
This page's target audience is new students just welcomed into any active applied group.
  
 
== Overview ==
 
== Overview ==
* read the [[About Us]] page
+
* Read the [[About Us]] page for department information.
* there's generally a pool of projects available
+
* There's generally a pool of projects available and ongoing at any time.
* you can pick what project you work on
+
* We perform maintenance as well as implement new projects.
* we perform maintenance as well as implement new projects
+
* Your specific hours and role will vary.
  
 
== Workspaces ==
 
== Workspaces ==
 +
Most work is done in the Center for Science and Technology (CST) on the second floor. In practice, that looks like this:
 +
* CST 217: study space and small-group meetings
 +
* CST 219: Lovelace computers
 +
* CST 222: warehouse and interactive work spaces
 +
* CST 227: bigger meetings and Iceland work
 +
* CST 108: shop and warehouse
 +
 +
Occasional work may take you to our older spaces (requires approval for keys):
 
* Dennis roof
 
* Dennis roof
* Noyes basement
+
* Noyes basement including servers
* Green Zone
 
  
=== Keys ===
+
== Keys ==
 
* go [http://form.jotform.us/form/41466536567161 here]
 
* go [http://form.jotform.us/form/41466536567161 here]
 
* fill it out and include applicable locations
 
* fill it out and include applicable locations
Line 20: Line 29:
 
** Noyes basement, CAB 13
 
** Noyes basement, CAB 13
 
** CS/physics lounge, CAA6
 
** CS/physics lounge, CAA6
* public Safety should email you when your keys are ready
+
* Public Safety should email you when your keys are ready
  
 
== Computers ==
 
== Computers ==
get someone to make username, passwd
+
You'll be given a username and password when you take any CS class. That will open the Lovelace computers to you.
* ACL's
 
* proto (going away)
 
* new-proto (will eventually become proto)
 
 
 
== Projects==
 
Check [[HIP]] for up-to-date project listings.
 
  
== Communication ==
+
In an applied group you will also be given access to a range of servers. Again this will vary by role.
  
=== Group ===
+
== Group Communication ==
* we use a listserv, hip@cs.earlham.edu
+
* Most groups have a listserv.
* notify the group about significant progress via listserv or in meetings
+
* Notify the group about significant progress via listserv or in meetings.
* questions can be asked via listserv
+
* Regular meeting notes are kept in Drive and generally shouldn't go here. Add meeting notes only if they are relevant to project completion.
* google drive is used frequently
 
  
=== Meetings ===
+
== Meetings ==
* Friday in the Green Zone for lunch (12-1pm)
+
* Regular group meetings will be scheduled. Typically they take place once a week at a lunchtime.
** general discussion about current and future projects
+
* Your group may also meet for a collaborative project work once a week if desired.
** bring-your-own-lunch style
 
  
* Sunday on the roof (1-3pm)
+
== Documentation ==
** working together in the same space
+
Documentation can be overdone but is important. If we don't know a project's current state, replicating or reproducing it can consume a lot of work cycles. This isn't valuable.
  
=== Documentation ===
+
So please at least keep some basic notes and update the wiki occasionally. Faculty will do its part to remind you and keep up their/our share.
Documentation is an important part of HIP because different people from different semesters will need to know about the work you did. It's also more efficient to point the curious here rather than to explain something multiple times.
 
  
* document projects
+
Here are some guidelines:
** inline code documentation helps readability
+
* Inline code documentation helps readability.
** wiki articles are fast and helpful
+
* Wiki articles are fast and helpful, so it is our preferred method of long-term documentation.
** document changes to keep information relatively accurate
+
* If it's in a Drive Document and it's important, it should make its way here at some point.
 +
* Please be specific. If X is wonky, so a student comes to the wiki to learn about X, and they read "X is wonky", that's barely helpful. Be specific about issues, fixes that have been tried, alternatives chosen, etc.
  
* document your work, process, or experience
+
=== Wiki Basics ===
** your experience is invaluable to someone who is in a similar situation
 
  
==== Wiki Basics ====
+
We'll get you a wiki account.
  
* how to use
+
Some tips for how to use it:
** you need an account to be created by an admin; ask Charlie or Ivan
+
* use [[Wiki Syntax]], and look at the syntax of other pages if you're confused
** if a page doesn't exist, search for it and the wiki will let you create that page
+
* use the "Show preview" button
 +
* if a page doesn't exist, search for it and the wiki will let you create that page
 
** make sure to click "Save Page" after you're finished editing
 
** make sure to click "Save Page" after you're finished editing
  
* how to learn
+
Styling tips:
** edit pages to look at their syntax
+
* Having too many headers can be overkill.
** use [[Wiki Syntax]]
+
* Lists are the simplest way to organize content.
 
+
* Trim things down but be complete and specific.
* how to style
 
** having too many headers can be overkill
 
** lists are the simplest way to organize content
 
** trim things down
 

Revision as of 12:23, 26 June 2018

Welcome to the Earlham CS Department!

This page's target audience is new students just welcomed into any active applied group.

Overview

  • Read the About Us page for department information.
  • There's generally a pool of projects available and ongoing at any time.
  • We perform maintenance as well as implement new projects.
  • Your specific hours and role will vary.

Workspaces

Most work is done in the Center for Science and Technology (CST) on the second floor. In practice, that looks like this:

  • CST 217: study space and small-group meetings
  • CST 219: Lovelace computers
  • CST 222: warehouse and interactive work spaces
  • CST 227: bigger meetings and Iceland work
  • CST 108: shop and warehouse

Occasional work may take you to our older spaces (requires approval for keys):

  • Dennis roof
  • Noyes basement including servers

Keys

  • go here
  • fill it out and include applicable locations
    • Dennis back entrance, CAX
    • Dennis roof, CAB 6
    • 2nd floor lab, CAA3
    • Noyes basement, CAB 13
    • CS/physics lounge, CAA6
  • Public Safety should email you when your keys are ready

Computers

You'll be given a username and password when you take any CS class. That will open the Lovelace computers to you.

In an applied group you will also be given access to a range of servers. Again this will vary by role.

Group Communication

  • Most groups have a listserv.
  • Notify the group about significant progress via listserv or in meetings.
  • Regular meeting notes are kept in Drive and generally shouldn't go here. Add meeting notes only if they are relevant to project completion.

Meetings

  • Regular group meetings will be scheduled. Typically they take place once a week at a lunchtime.
  • Your group may also meet for a collaborative project work once a week if desired.

Documentation

Documentation can be overdone but is important. If we don't know a project's current state, replicating or reproducing it can consume a lot of work cycles. This isn't valuable.

So please at least keep some basic notes and update the wiki occasionally. Faculty will do its part to remind you and keep up their/our share.

Here are some guidelines:

  • Inline code documentation helps readability.
  • Wiki articles are fast and helpful, so it is our preferred method of long-term documentation.
  • If it's in a Drive Document and it's important, it should make its way here at some point.
  • Please be specific. If X is wonky, so a student comes to the wiki to learn about X, and they read "X is wonky", that's barely helpful. Be specific about issues, fixes that have been tried, alternatives chosen, etc.

Wiki Basics

We'll get you a wiki account.

Some tips for how to use it:

  • use Wiki Syntax, and look at the syntax of other pages if you're confused
  • use the "Show preview" button
  • if a page doesn't exist, search for it and the wiki will let you create that page
    • make sure to click "Save Page" after you're finished editing

Styling tips:

  • Having too many headers can be overkill.
  • Lists are the simplest way to organize content.
  • Trim things down but be complete and specific.