Author: buildbot Date: Tue Nov 20 09:21:39 2018 New Revision: 1037123 Log: Staging update by buildbot for tomee
Modified: websites/staging/tomee/trunk/cgi-bin/ (props changed) websites/staging/tomee/trunk/content/ (props changed) websites/staging/tomee/trunk/content/dev/writing-examples.html Propchange: websites/staging/tomee/trunk/cgi-bin/ ------------------------------------------------------------------------------ --- cms:source-revision (original) +++ cms:source-revision Tue Nov 20 09:21:39 2018 @@ -1 +1 @@ -1844535 +1846984 Propchange: websites/staging/tomee/trunk/content/ ------------------------------------------------------------------------------ --- cms:source-revision (original) +++ cms:source-revision Tue Nov 20 09:21:39 2018 @@ -1 +1 @@ -1844535 +1846984 Modified: websites/staging/tomee/trunk/content/dev/writing-examples.html ============================================================================== --- websites/staging/tomee/trunk/content/dev/writing-examples.html (original) +++ websites/staging/tomee/trunk/content/dev/writing-examples.html Tue Nov 20 09:21:39 2018 @@ -148,7 +148,7 @@ <p>Writing examples that can be used in a presentations is hard.</p> -<p>Some basic guideliness of writing examples:</p> +<p>Some basic guidelines of writing examples:</p> <ul> <li>focus on one idea per example</li> @@ -158,13 +158,13 @@ <li>minimal code to make the point</li> </ul></li> <li>avoid showing an entire API in one example, if possible</li> -<li>be concious of the cost of "setting the stage"</li> +<li>be conscious of the cost of "setting the stage"</li> <li>if examples get too big, split it</li> </ul> <h1>Noise vs signal</h1> -<p>It takes time to learn the example scenario (noise). You need to learn the scenario before you can start to see the imporant parts (signal).</p> +<p>It takes time to learn the example scenario (noise). You need to learn the scenario before you can start to see the important parts (signal).</p> <p>Be very mindful of your noise to signal ratio.</p> @@ -176,7 +176,7 @@ <p>If there are five ways to do the same thing, avoid making five different scenarios. Copy the example to a new directory, and tweak it to show the variation.</p> -<p>So say you used objects <code>Green</code>, <code>Square</code> and <code>Checkers</code> to show the basic concept and you wish to show the next variation of that same concecpt. It is tempting to add to the same +<p>So say you used objects <code>Green</code>, <code>Square</code> and <code>Checkers</code> to show the basic concept and you wish to show the next variation of that same concept. It is tempting to add to the same example objects <code>Yellow</code>, <code>Triangle</code> and <code>PolkaDots</code>.</p> <p>Avoid that. Copy <code>Green</code>, <code>Square</code> and <code>Checkers</code> to a new example, change the package name, and update the few lines needed to show the difference.</p>