forked from gewgaws/git-for-writers
-
Notifications
You must be signed in to change notification settings - Fork 0
/
scenario1_tutorialpage.htm
207 lines (182 loc) · 9.06 KB
/
scenario1_tutorialpage.htm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" id="mysite-com">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Git for Writers: Scenario 1</title>
<link rel="stylesheet" type="text/css" media="screen, print" href="css/reset.css" />
<link rel="stylesheet" type="text/css" media="screen" href="css/screen.css" />
<!--[if lte IE 7>
<link rel="stylesheet" type="text/css" media="screen" href="css/screen-ie.css" />
<![endif]-->
<link rel="stylesheet" type="text/css" media="print" href="css/print.css" />
<!--REMOVE COMMENT TAGS TO USE FACEBOOK SHARE METADATA:-->
<!--
<meta name="title" content="Match this with the content of the title tag above." />
<meta name="description" content="A short description of this page." />
<link rel="image_src" href="http://example.com/media/share/thumbnail.jpg" />
-->
<!--REMOVE COMMENT TAGS TO USE FAVICON LINKS:-->
<!--
<link rel="icon" href="" type="image/png" />
<link rel="shortcut icon" href="" type="image/png" />
-->
<script type="text/javascript" src="js/mootools/mootools-core.js"></script>
<script type="text/javascript" src="js/site.js"></script>
</head>
<body>
<div id="page">
<div id="header">
<h1><a href="http://gewga.ws/git-for-writers/" rel="home">Git for Writers</a></h1>
<p class="tagline">
A guide to version tracking, revision, and collaboration for open-source writing.
</p>
<ul class="accessibility">
<li><a href="#navigation">Jump to Navigation</a></li>
<li><a href="#content">Jump to Content</a></li>
</ul>
</div>
<div id="content">
<div id="main">
<h2>Scenario 1: Developing a course syllabus</h2>
</div>
<div id="content">
<h3>Scenario description</h3>
<p>You are the new instructor of an undergraduate technical writing course to be offered in an upcoming semester. Over the next six weeks, you want to develop the course syllabus, which will be uploaded to the course Web site as an HTML document. The syllabus sections will be added iteratively and include:
<ul>
<li>Course overview, objectives
<li>Readings/assignments calendar</li>
<li>Grading, project requirements</li>
<li>University policies</li>
</ul>
</p>
<h4>Week one</h4>
<h3>Create new document & syllabus outline</h3>
<img alt="figure 1" width="320px" align="right" src="scenario1_figure1.png"/>
<ol>
<li>Creating an HTML document for the syllabus
<ol>
<li>You've already completed <a href="">Git Setup</a>.</li>
<li>You <a href="">Create a New Project</a> in the <em>projects</em> folder of the home directory.
<li>You create and save a new HTML file COM104_syllabus.htm in the <em>projects</em> folder.</li>
<li>You copy a CSS file you had used for another course and save it in the <em>projects</em> folder as syllabi.css.</li>
<li>You work for 30 minutes on the outline and appearance of the COM104_syllabus.htm document until it looks like <strong>Figure 1</strong>.
</ol>
</li>
<li>Saving to a repository</li>
<ol>
<li>Since you now have two files to be saved to a repository, you <a href="">Initialize a Repository</a> for <em>com104</em> and <a href="">Stage a Commit</a> for them.
<li>Next, you <a href="">Make a Commit</a> to save your project's working copy with in the <em>com104</em> repository.</li>
</ol>
</ol>
<h4>Week two</h4>
<h3>Add course calendar outline & grading scale</h3>
<img alt="figure 2" width="320px" align="right" src="scenario1_figure2.png"/>
<ol>
<li>Updating existing documents
<ol>
<li>You add a calendar table under the Course Calendar section and a grading scale table under the Grading & Project Requirements section of COM104_syllabus.htm. The syllabus now looks like <strong>Figure 2</strong>.</li>
<li>You <a href="">Make a Commit</a> to match your project's working copy with the <em>com104</em> repository copy.</li> </ol>
</li>
<li>Branching sideways to preserve current version
<ol>
<li>To preserve the current document as a form for other syllabi in the future, you decide to "branch sideways," or <a href="">Initialize a Repository</a> called <em>courses</em> for the files and <a href="">Stage a Commit</a> for them.</li>
<li>You then <a href="">Make a Commit</a> to match the working copy to the new <em>courses</em> repository.</li>
</ol>
</li>
</ol>
<h4>Week three</h4>
<h3>Flesh out calendar & add course objectives</h3>
<img alt="figure 3" width="320px" align="right" src="scenario1_figure3.png"/>
<ol>
<li>Updating existing documents
<ol>
<li>You add some of the assigned readings and in-class exercises to the calendar table and finish the course objectives. The syllabus now looks like <strong>Figure 3</strong>.</li>
<li>You <a href="">Make a Commit</a> to match your project's working copy of COM104_syllabus.htm to the <em>com104</em> repository copy.</li>
</ol>
</li>
<li>Reviewing document history: Before moving on to other work, you <a href="">Track Changes</a> to review all of the changes you made to the document today.
</ol>
</li>
</ol>
<h4>Week four</h4>
<h3>Update university policies & make consistent with course objectives</h3>
<img alt="figure 4" width="320px" align="right" src="scenario1_figure4.png"/>
<ol>
<li>Updating existing documents
<ol>
<li>The University has just released their updated academic policies. You copy, paste, and format the policies in the syllabus document.</li>
<li>You change the course objectives to make them consistent with the University policies' grading and participation criteria.</li>
<li>You <a href="">Make a Commit</a> to match your project's working copy of COM104_syllabus.htm to the <em>com104</em> repository copy.</li>
</ol>
</li>
<li>Adding select update to other branch
<ol>
<li>You also want to add the updated university policies to the syllabus document in the <em>courses</em> branch, so you <a href="">Switch Branches</a>.</li>
<li>You then use <a href="">Cherry-Picking</a> to commit only the university policies update to the syllabus.htm document in the <em>courses</em> branch.</li>
</ol>
</li>
</ol>
<h4>Week five</h4>
<h3>Finish calendar & project requirements</h3>
<img alt="figure 5" width="320px" align="right" src="scenario1_figure5.png"/>
<ol>
<li>Updating existing documents
<ol>
<li>You finish adding the assignments and readings to the course calendar table and add requirement descriptions for each major project assignment.</li>
<li>You <a href="">Make a Commit</a> to match your project's working copy of COM104_syllabus.htm to the <em>com104</em> repository copy.</li>
</ol>
</li>
<li>Rolling back last week's changes to course objectives
<ol>
<li>You realize that course objectives should be more consistent with the course calendar and not the university policies, so you want to restore the previous version of the text.</li>
<li>You use a <a href="">New Commit to Revert</a> the unwanted changes to course objectives.</li>
</ol>
</li>
</ol>
<h4>Week six</h4>
<h3>Finish course description & make final edits</h3>
<ol>
<li>Updating existing documents
<ol>
<li>You make some final edits to the text of the syllabus document.</li>
<li>You then experiment with format by making several changes to the syllabus.css document.</li>
</ol>
</li>
<li>Accepting only some of the changes
<ol>
<li>You decide to only accept the textual changes, so you use <a href="">Git Checkout</a> to restore the <em>project</em> repository's version of syllabus.css and restore COM104_syllabus.htm to the revised version.</li>
</ol>
</li>
</ol>
</div>
<div id="supporting">
</div>
</div>
<ul id="navigation">
<li><a href="index.htm">Home</a></li>
<li><a href="resources.htm">Resources</a></li>
<li><a href="about.htm">About</a></li>
</ul>
<div id="footer">
<p class="copyright">
© 2010 by Gewgaws Lab. Some rights reserved. Content licensed under a
<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/us/">
Creative Commons Attribution-Share Alike 3.0 United States License
</a>.
<a class="cc-badge" rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/us/">
<img alt="Creative Commons License" src="http://i.creativecommons.org/l/by-sa/3.0/us/88x31.png" />
</a>
</p>
<p class="project-information">
<a href="http://github.com/gewgaws/git-for-writers">Git for Writers repository</a>
hosted at <a href="http://github.com">GitHub</a>. Learn <a href="participate.htm">how to
contribute</a> to Git for Writers.
</p>
<ul class="validators">
<li><a href="http://validator.w3.org/check?uri=referer" title="Validate this page's XHTML">XHTML</a></li>
<li><a href="http://jigsaw.w3.org/css-validator/check/referer" title="Validate this page's CSS">CSS</a></li>
</ul>
</div>
</div>
</body>
</html>