EDGE Tutorial and Sample Project Overviewedge.rit.edu/edge/P14414/public/WorkingDocuments/MSD-EDGE_Tut… · • See a brief EDGE overview • See some sample projects, good and bad

R . I . T Mechanical Engineering

EDGE Tutorial and

Sample Project Overview

RIT-KGCOE

Multidisciplinary Senior Design


Outline: In this session, you will…

• See a brief EDGE overview

• See some sample projects, good and bad

• Visit your team’s EDGE website

• Make wiki-based edits to your team’s website

• Subversion overview

• Create your own local working copy of your

team’s EDGE repository

• Make svn-based changes to your team’s EDGE

repository


Assumptions

• You have already installed Tortoise SVN (PC),

SCPlugin (Mac), or some other Subversion

client on your computer.

• KGCOE PC labs should all have Tortoise installed and the

contextual menus will show up

• You have editor-level access to your team’s

EDGE site.

• You have easy access to an electronic file to

post to EDGE.


Where to download

• This should be done before starting this tutorial!

Each site includes download/install instructions.

• TortoiseSVN (PC):

• http://tortoisesvn.net/downloads.html

• SCPlugin (Mac):

• http://scplugin.tigris.org/servlets/ProjectProcess?pageID=4adHJG











repository


About EDGE

• Open-source, developed by students, staff, and faculty at RIT.

• A means of facilitating document sharing and version control (MSD and other)

• A means of controlling the visibility of documents (public vs. private)

• Where we archive MSD projects so that future MSD teams, UG/G researchers, and classes can access them


More About EDGE

• EDGE ≠ Google Docs

• Google Docs: great for live multi-person editing

• Google Docs: great for within-document revision control

• EDGE ≅ Dropbox

• When your 2 semesters of MSD are over, we need to maintain

your design history file.

All work submitted for MSD

must reside on EDGE!

(Excerpt from Process grade,

worth 20% of total)











repository


Sample project: P12361

• Explore their web interface

• http://edge.rit.edu/edge/P12361/public/Home

• Front page

• Not too busy

• Links to pages with subsets of team information (Planning &

Execution, Detailed Design, etc.)

• Other pages:

• LOTS of information

• Use TOC to help visitors navigate

• Contain links to additional information


Sample project: P12361

• Explore their public directory listing

• http://edge.rit.edu/edge/P12361/public

• Main folder:

• Too many files

• Detail Design vs Detailed Design?

• constraints.doc vs constraintspdf.doc vs conpdf.doc?

• Subfolders:

• Some used effectively

• One only has one file in it


Instructions

• Explore the following teams’ sites (or another if

your guide suggests it):

• https://edge.rit.edu/edge/P13031/public/Home

• https://edge.rit.edu/edge/P13071/public/Home

• Use the questions on the next slide as a guide

• For a well-documented project, you will be able to answer

these questions fairly easily.

As you read through these sites, remember that there

is no single best way to present every project!


Instructions (cont.)

• Who was the customer? Who was the sponsor? What

problem was the team solving? Were they successful?

• If I were on a follow-on team, what would our main

goals be?

• Where are their final CAD package, Bill of Materials,

and performance vs. specifications?

• Was the team’s EDGE site intuitive to navigate?

• Was the directory structure easy to navigate?

• What elements of the site will you incorporate (or not)

into your own?











repository


Your EDGE navigation bar

• “Edit User Info” to control your own settings:

View/edit info

about you

Projects in

your nav bar


Edit User Info

• Make yourself an “Observer” (if you aren’t

already one)

About you

Projects in

your nav bar

Projects not in

your nav bar











repository


Wiki-based editing

• See some basic wiki editing techniques

• See where to go for help with wiki editing

• Practice wiki editing


Click here to edit node


Wiki editing

window

Preview

Area

Wiki “cheat sheets”

(see next slide for

examples)


Wiki Markup Examples

LOTS of examples here – use the Table of Contents

to jump right to the kind of help you need…


https://edge.rit.edu/edge/Resources/public/Help/Wiki%20Markup%20Examples

You can (and

should) copy

and paste the

syntax directly

into your own

edit window

and customize

as needed!


Warning!

• Two people editing the same wiki node at the same

time can create conflicts. Be sure only one team

member is editing at a time.

• Enter a useful Change Summary before saving your

edits.

• Try to avoid uploading files to EDGE using the web

interface. We will get to this later in the tutorial.

• If you do upload a file now, be sure to upload it to a node that includes

the proper file extension (.docx, .xlsx, .pdf, etc…)

• Communicate within your team!


Instructions

• Each team member should choose one portion of the

website to edit for this exercise. Communication is

critical to avoid conflict!

• Suggested edits:

• Homepage – Project Summary, Project Information, Team Members

• Planning & Execution – add Customer Needs and Specifications, link

to separate page for customer interview questions and notes

• Customer Interviews – post questions

• Systems Design – benchmarking

• Team Norms & Values – expectations for team behavior











repository


Tortoise (SCPlugin) & Subversion Basics

• Once: Install Tortoise (or SCPlugin, or similar).

• Checkout a working copy of your project

(P13xxx) to your local working folder (once).

• Update your working copy before starting to do

work (every time).

• Do your work locally (every time).

• Commit local changes back up to the server

(every time).


EDGE &

P13000

repository

Marge, on Team P13000 Homer, on Team P13000

EDGE=server that stores all

MSD information. Team

P1300 has a project on the

EDGE server. Marge and

Homer are two of P13000’s

team members.


EDGE &

P13000

repository


Checkout Checkout

Team members checkout the

project repository and now

each has their own local

working copy of the team’s

work. This happens once.


EDGE &

P13000

repository


Hmmm…gu

ess I’ll get

started on

MSD…

1. Update

3. Commit 2. Do local

work,

save

Marge sits down to work:

update, do local work, and

commit changes to the

server. Server now has most

up-to-date version of team’s

work. Homer doesn’t know

yet because he’s watching

reruns of the 2010 Frozen

Four on youtube.


EDGE &

P13000

repository


Looks like

Marge has

been busy!

1. Update

3. Commit

2. Do local work,

including

modifications to

Marge’s work,

save

Homer sits down to work,

and updates his local

working copy. He now has

the most recent version of

Marge’s work, and can add

to or modify what’s there.

When done, he saves and

commits HIS changes. The

server contains the most

recent version of the team’s

work once again.


EDGE &

P13000

repository


Dr. DeBartolo,

Team P13000 Guide

Team P1300 is on

the right track. I can

tell by their clear

and thorough

documentation!

Update

Guide, customer, or sponsor

can monitor progress and

provide feedback.


EDGE &

P13000

repository


Dr. DeBartolo,

Team P13000 Guide

Does team

P13000 know that

classes started 6

weeks ago?

Update

If you don’t keep EDGE up

to date, these people will

think you’ve done nothing!











repository


Checkout Procedure

• Figure out where you want your local copy

• Suggestion: one local copy per owned device (e.g., you may

have one on your flash drive to use in PC lab, one on a home

computer, and one on a laptop)

• Avoid checkouts to PC lab machines – hard drives fill

quickly!

• Find your project’s dav address

• Checkout (recursive, head revision)

• recursive = check out complete repository tree

• head revision = from the most recent commit

• Screenshots follow…


Checkout a working copy from EDGE

ctrl-click or

toolbar menu

PC: TortoiseSVN Mac: SCPlugin

right-click


PC Mac

Your project # goes here

The Repository URL is the “DAV address”…

…which you can find here


After Checkout


Instructions

• Checkout your team’s repository to your local

device.

• When you have successfully checked out, you

can move on to the next step.


Problems…?

• “I checked out my repository, but there’s

nothing there.”

• Check to make sure you checked out all subfolders, and that

your checkout is recursive.

• “I hit ‘OK’ after I entered the checkout

information, and the system just hangs, with no

error.”

• Sometimes the window to prompt you for your login/password

shows up behind the other windows – look around.


Problems…?

• “I use SCPlugin on a Mac, and I get a certificate

error.”

• This is a bug that seems to be affecting everyone with a newer OS

• Open your Terminal application (command-line interface)

• Perform any SVN operation here and choose to (P)ermanently

accept the certificate.

• At the prompt, type an svn command, like checkout, update, or

commit (see next slide for example):

svn checkout [DAV address] [path for working copy]

• If this doesn’t work (newer OS), try:

/usr/local/bin/svn checkout [DAV address] [path for working copy]











• Make svn-based changes to your team’s

EDGE repository


Warnings!

• Update immediately before starting work

• Commit immediately after finishing work (or

mid-way through)

• Conflicts happen, but rarely – Tortoise or

SCPlugin will notify you. Communication is

key!

• Retain appropriate file extensions in order to

avoid mime type problems


First, Update.

PC Mac

Update just before you start work to

make sure you have the most up-to-

date version of your team’s information!


Next, do work. • Edit files:

• Make whatever changes you need to the contents or properties of

existing files

• Create new files:

• ADD the new file(s) using the Tortoise or SCPlugin contextual

menus

• Until you ADD them, they will not show up on the COMMIT menu

• Remove files:

• DELETE the file(s) using the Tortoise or SCPlugin contextual menus

• Don’t just drag them to the trash!

• When you’re done, COMMIT all changes…


Finally, Commit.

PC Mac

Use meaningful

descriptions Can’t select files to COMMIT unless

you’ve already done an ADD


Change Log: Meaningful Commit Notes


More warnings!

• Be careful of similar file names! The following

are all different in EDGE:

• Detailed Design

• Detailed design

• Detailed_Design

• DetailedDesign

• Avoid the following symbols in filenames

• !@#$%^&*()/|\[]{}`’?<>:

• Spaces (if you plan to use a command-line interface)

• Stick with capital & lowercase letters, numbers, and “–” or “_”,

and you’ll be OK.


A side note about mime types…

Mime type For File Types…

text/wiki Wiki node

application/octet-stream Most binary files

application/mspowerpoint Microsoft Powerpoint

application/msword Microsoft Word

application/ms-excel Microsoft Excel

text/plain Plain text, ASCII

application/pdf Adobe PDF

If you do a major edit

to a wiki node using a

text editor offline, you

will probably have to

set the mime type

back to text/wiki.


Change mime type

• Must be on a PC to do this through GUI

• Right-click >> TortoiseSVN >> Properties

• Edit or Add a mime type

• On a Mac, launch Terminal and run this

command:

• svn propset svn:mime-type [mime type here] [file name here]


Change mime type (PC)

If there is a mime type

set, you can edit it.

Otherwise, you need

to add a new property:

select Mime Type

Beware multiple

Properties options!

It’s easiest to use

the one you find

under TortoiseSVN.


Instructions (1/3)

• Assumption: You each have a document

containing one of the following:

• List of questions for customers

• Interview notes

• Team Norms and Values

• Individual schedules and/or contact information

• Move your file to the public directory (or

wherever you want it to reside)

• Add the file to revision control

• Commit changes back to the server


Instructions (2/3)

• Assumption: You have each successfully put

your file up on the server.

• Add a link to this file on your team’s EDGE site

• Use the tips at

https://edge.rit.edu/edge/Resources/public/Help/Wiki%20Markup

%20Examples#Links

• Remember that you’ve already uploaded the file, so its name is

already determined, and includes .pdf (or .docx, or similar).

• Make the link on your page appear to be regular text, such as,

“Click here for my elevator speech project description

https://www.rit.edu/


Instructions (3/3)

• Back in your local working copy, UPDATE your

repository

• Your team members’ additions/modifications should appear.

• Your own web-based modifications should appear.


That’s it!

• You’ve all edited a wiki, used a subversion

client, and shared documents within your team.

• Remember the wiki tips

• Refer to this tutorial on myCourses for help

If you have problems or questions, post them to

the EDGE-SVN discussion board on myCourses!