Merge commit '4172259' into dev

chrqls · Jun 18, 2014 · db11515 · db11515
2 parents 11c653b + 4172259
commit db11515
Show file tree

Hide file tree

Showing 9 changed files with 781 additions and 193 deletions.
diff --git a/README.md b/README.md
@@ -31,6 +31,7 @@ Tests
 Making the Docs
 ===============
 
+* Install https://github.com/truedat101/gitchanges
 * Use Hugo ... so install it
 * rm -rf docs/public (only do this if you are knowing what you do and why you would do this, it should only need to be done once and it's done so don't touch it)
 * git subtree add --prefix docs/public [email protected]:RazortoothRTC/node-smile-server.git gh-pages --squash
@@ -44,6 +45,7 @@ Updating the Docs
 
 * git subtree pull --prefix=docs/public
 * Update the docs
+* If you are making a release, run < node-smile-server >/docs/tools/genreleasenotes.sh > currentrelease.txt , and put these notes into meta/release-notes.md
 * Run hugo from docs dir (to generate the new doc changes)
 * git commit -a
 * git subtree push  --prefix=docs/public [email protected]:RazortoothRTC/node-smile-server.git gh-pages

diff --git a/docs/content/guides/teacherweb.md b/docs/content/guides/teacherweb.md
@@ -2,33 +2,45 @@
 title: "Epoch SMILE Teacher Web Guide"
 date: "2014-06-04"
 aliases:
-  - "/doc/permalinks/"
+  - "/doc/smileteacherweb/"
 groups: ["guides"]
 groups_weight: 30
-notoc: true
+notoc: false
 ---
 
-By default, content is laid out into the target `publishdir` (public)
-namespace matching its layout within the `contentdir` hierarchy.
-The `permalinks` site configuration option allows you to adjust this on a
-per-section basis.
-This will change where the files are written to and will change the page's
-internal "canonical" location, such that template references to
-`.RelPermalink` will honour the adjustments made as a result of the mappings
-in this option.
-
-For instance, if one of your sections is called `post` and you want to adjust
-the canonical path to be hierarchical based on the year and month, then you
-might use:
-
-```yaml
-permalinks:
-  post: /:year/:month/:title/
-```
-
-Only the content under `post/` will be so rewritten.
-A file named `content/post/sample-entry` which contains a line
-`date: 2013-11-18T19:20:00-05:00` might end up with the rendered page
-appearing at `public/2013/11/sample-entry/index.html` and be reachable via
-the URL <http://yoursite.example.com/2013/11/sample-entry/>.
+TODO
 
+# Logging In
+
+TODO
+
+## Phasae I - Start Making Questions
+
+When the class is ready, the Teacher will initiate the "Start Making Questions" Phase.  The student will be asked by the Teacher to create one or more questions with complete answers.
+
+![SMILE Student - Start Making Questions](/static/img/smilestudent-startmake.png)
+
+## Phase II - Start Answering Questions
+
+When all of the students have created an acceptable number of questions, the Teacher will move to the "Start Answering Questions" phase.  The Stuedent will be presented with a set of one or more questions to answer.  The questions are in the form of Multiple Choice, so the format will be familiar to many students.
+
+![SMILE Student - Start Answering Questions](/static/img/smilestudent-startanswer.png)
+
+After completing answers for all questions, the Student will be asked to wait for the teacher to wrap up the session and present results.
+
+![SMILE Student - Start Answering Questions 2](/static/img/smilestudent-startanswer2.png)
+
+
+## Phase III - View Results
+
+When the Teacher is ready to present the results, the results will be displayed in the browser.
+
+![SMILE Student - Results](/static/img/smilestudent-results.png)
+
+## Phase IV - After The Session, Recap
+
+At this point, it is up to the teacher to transition the students from the SMILE session into a recap of the session and help the students to dissect their own work, and evaluate peers.  Examination of question quality is important.
+
+Not Yet Implemented
+
+* Advanced visualization of results
diff --git a/docs/content/meta/release-notes.md b/docs/content/meta/release-notes.md
diff --git a/docs/public/doc/smileteacherweb/index.html b/docs/public/doc/smileteacherweb/index.html
@@ -0,0 +1 @@
+<!DOCTYPE html><html><head><link rel="canonical" href="http://razortoothrtc.github.io/node-smile-server/guides/teacherweb"/><meta http-equiv="content-type" content="text/html; charset=utf-8" /><meta http-equiv="refresh" content="0;url=http://razortoothrtc.github.io/node-smile-server/guides/teacherweb" /></head></html>
diff --git a/docs/public/guides/studentandroid/index.html b/docs/public/guides/studentandroid/index.html
@@ -127,7 +127,7 @@ <h2 id="toc_0">Background</h2>
 
 <p>For details about the <a href="https://gse-it.stanford.edu/research/project/smile">Stanford Mobile Inquiry-Based Learning Environment</a>, visit their site and learn more</p>
 
-<p>The source code was given to the <a href="http://smileconsortium.org">SMILE Consortium, Inc.</a> through improper channels by a Stanford faculty member.  While intentions were good, the <a href="http://otl.stanford.edu/">Stanford University of Technology Licensing</a> was not involved as was promised, unbeknownst to the board members of the <a href="http://smileconsortium.org">SMILE Consortium, Inc.</a>.  As a board member, the project leader of the Open Source raised the issue about Intellectual Property, but was later forced to leave over differences with the <a href="http://smileconsortium.org/ourteam">current leadership</a> over handling of the issue.</p>
+<p>The source code was given to the <a href="http://smileconsortium.org">SMILE Consortium, Inc.</a>, a 501-c3 non-profit) through improper channels by a Stanford faculty member.  While intentions were good, the <a href="http://otl.stanford.edu/">Stanford University of Technology Licensing</a> was not involved as was promised, unbeknownst to the board members of the <a href="http://smileconsortium.org">SMILE Consortium, Inc.</a>.  As a board member, the project leader of the Open Source raised the issue about Intellectual Property, but was later forced to leave over differences with the <a href="http://smileconsortium.org/ourteam">current leadership</a> over handling of the issue.</p>
 
 <p>The Epoch SMILE source was developed in a clean room environment, without access to the source code from Stanford.  The development of the Server, IQManager, SMILE Plug, SMILE Student Web, SMILE Teacher Web, is all very well documented and can be traced from drawing board to inception, without taininting of any Stanford code, funding, or support.  In fact, SMILE Consortium offered no material support of these projects, though the leader of the technology projects tried to get the organization working towards the goal of supporting these projects, it was in vain.  The Open Source work that existed independent of Stanford been forked from the <a href="https://github.com/SMILEConsortium">SMILE Consortium Github</a>, and work continues to be developed in the open by <a href="https://github.com/RazortoothRTC">Razortooth Communications, LLC</a>.</p>
 
@@ -139,7 +139,7 @@ <h2 id="toc_1">Issues With Intellectual Property</h2>
 
 <h2 id="toc_2">Source Code</h2>
 
-<p>Anyone interested in legal use of the SMILE Android Student App or SMILE Java Teacher Desktop Application should contact the <a href="http://otl.stanford.edu/">Stanford University of Technology Licensing</a>.</p>
+<p>Anyone interested in legal use of the SMILE Android Student App or SMILE Java Teacher Desktop Application should contact the <a href="http://otl.stanford.edu/">Stanford University of Technology Licensing</a>.  The code available is listed below.  It is not associated with the work of Epoch SMILE and is created either by Stanford staff or by the SMILE Consortium volunteers.  The legal status is unclear until one gets clarity from Stanford&rsquo;s Technology Licensing team.</p>
 
 <ul>
 <li><a href="https://github.com/SMILEConsortium/smile_adhoc_android">SMILE Student Android App</a> - Removed repository in December 2013, recently <a href="https://github.com/SMILEConsortium/smile_adhoc_android/commit/b4f8f0fb3e069935d30601f43fdb963749149122">added back</a> on April 28th, 2014</li>
@@ -149,7 +149,7 @@ <h2 id="toc_2">Source Code</h2>
 
 <h2 id="toc_3">Epilogue</h2>
 
-<p>It is important that people understand good intentions don&rsquo;t justify actions.  Integrity matters.  Ethics matter.  The law matters.  When it comes to Intellectual Property and the Law, there are some clear rules to follow.  When it comes to ethics, it is important to hold to some moral standards, regardless of whether ethics may stifle one&rsquo;s ability to achieve ambitions or get a competitive edge.</p>
+<p>It is important that people understand good intentions don&rsquo;t justify actions.  Integrity matters.  Ethics matter.  The law matters.  When it comes to Intellectual Property and the Law, there are some clear rules to follow.  When it comes to ethics, it is important to hold to some moral standards, regardless of whether ethics may stifle one&rsquo;s ability to achieve ambitions or get a competitive edge.  When it comes to integrity, Open Source contributors need to disclose whether they have the right to contribute, or whether work contracts or conflict of interest may block one&rsquo;s legal ability to contribute.  Failure to disclose is lack of integrity and puts an entire project at risk.</p>
 
 <p>As a proponent of Open Source, the author of this page, @dkords, has worked hard to follow the spirit of Open Source, and the law behind it.  The experience with the SMILE Consortium was a huge disappointment.  Through Razortooth, he continues to promote an ethical approach to creation of Open Source.  See the details of the new approach to project maintenance on the <a href="https://plus.google.com/u/0/112826671916880508140/posts/NFeeX1TwLDv">SMILE Plug G+ Community</a>.</p>
 

diff --git a/docs/public/guides/teacherweb/index.html b/docs/public/guides/teacherweb/index.html
@@ -102,29 +102,64 @@
         <div class="col-md-12">
 
 
+            <div id="toc" class="well col-md-4 col-sm-6">
+            <nav id="TableOfContents">
+<ul>
+<li><a href="#toc_0">Logging In</a>
+<ul>
+<li><a href="#toc_1">Phasae I - Start Making Questions</a></li>
+<li><a href="#toc_2">Phase II - Start Answering Questions</a></li>
+<li><a href="#toc_3">Phase III - View Results</a></li>
+<li><a href="#toc_4">Phase IV - After The Session, Recap</a></li>
+</ul></li>
+</ul>
+</nav>
+            </div>
+
           <h1>Epoch SMILE Teacher Web Guide</h1>
-          <p>By default, content is laid out into the target <code>publishdir</code> (public)
-namespace matching its layout within the <code>contentdir</code> hierarchy.
-The <code>permalinks</code> site configuration option allows you to adjust this on a
-per-section basis.
-This will change where the files are written to and will change the page&rsquo;s
-internal &ldquo;canonical&rdquo; location, such that template references to
-<code>.RelPermalink</code> will honour the adjustments made as a result of the mappings
-in this option.</p>
-
-<p>For instance, if one of your sections is called <code>post</code> and you want to adjust
-the canonical path to be hierarchical based on the year and month, then you
-might use:</p>
-
-<pre><code class="yaml">permalinks:
-  post: /:year/:month/:title/
-</code></pre>
-
-<p>Only the content under <code>post/</code> will be so rewritten.
-A file named <code>content/post/sample-entry</code> which contains a line
-<code>date: 2013-11-18T19:20:00-05:00</code> might end up with the rendered page
-appearing at <code>public/2013/11/sample-entry/index.html</code> and be reachable via
-the URL <a href="http://yoursite.example.com/2013/11/sample-entry/">http://yoursite.example.com/2013/11/sample-entry/</a>.</p>
+
+
+<p>TODO</p>
+
+<h1 id="toc_0">Logging In</h1>
+
+<p>TODO</p>
+
+<h2 id="toc_1">Phasae I - Start Making Questions</h2>
+
+<p>When the class is ready, the Teacher will initiate the &ldquo;Start Making Questions&rdquo; Phase.  The student will be asked by the Teacher to create one or more questions with complete answers.</p>
+
+<p><img src="http://razortoothrtc.github.io/node-smile-server/static/img/smilestudent-startmake.png" alt="SMILE Student - Start Making Questions" />
+</p>
+
+<h2 id="toc_2">Phase II - Start Answering Questions</h2>
+
+<p>When all of the students have created an acceptable number of questions, the Teacher will move to the &ldquo;Start Answering Questions&rdquo; phase.  The Stuedent will be presented with a set of one or more questions to answer.  The questions are in the form of Multiple Choice, so the format will be familiar to many students.</p>
+
+<p><img src="http://razortoothrtc.github.io/node-smile-server/static/img/smilestudent-startanswer.png" alt="SMILE Student - Start Answering Questions" />
+</p>
+
+<p>After completing answers for all questions, the Student will be asked to wait for the teacher to wrap up the session and present results.</p>
+
+<p><img src="http://razortoothrtc.github.io/node-smile-server/static/img/smilestudent-startanswer2.png" alt="SMILE Student - Start Answering Questions 2" />
+</p>
+
+<h2 id="toc_3">Phase III - View Results</h2>
+
+<p>When the Teacher is ready to present the results, the results will be displayed in the browser.</p>
+
+<p><img src="http://razortoothrtc.github.io/node-smile-server/static/img/smilestudent-results.png" alt="SMILE Student - Results" />
+</p>
+
+<h2 id="toc_4">Phase IV - After The Session, Recap</h2>
+
+<p>At this point, it is up to the teacher to transition the students from the SMILE session into a recap of the session and help the students to dissect their own work, and evaluate peers.  Examination of question quality is important.</p>
+
+<p>Not Yet Implemented</p>
+
+<ul>
+<li>Advanced visualization of results</li>
+</ul>
 
         </div>
       </div>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		<!DOCTYPE html><html><head><link rel="canonical" href="http://razortoothrtc.github.io/node-smile-server/guides/teacherweb"/><meta http-equiv="content-type" content="text/html; charset=utf-8" /><meta http-equiv="refresh" content="0;url=http://razortoothrtc.github.io/node-smile-server/guides/teacherweb" /></head></html>