index.html in newgem-0.10.2

- old
+ new

@@ -31,11 +31,11 @@
 <div id="main">
 
     <h1>New Gem Generator</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/newgem"; return false'>
       Get Version
-      <a href="http://rubyforge.org/projects/newgem" class="numbers">0.10.1</a>
+      <a href="http://rubyforge.org/projects/newgem" class="numbers">0.10.2</a>
     </div>
     <h1>&#x2192; &#8216;newgem&#8217;</h1>
 
 
 	<h2>What</h2>
@@ -135,21 +135,10 @@
 
 
 	<p>If you don&#8217;t want a website, remove the <code>website</code> related files from the Manifest.txt.</p>
 
 
-	<h2>Package and test locally</h2>
-
-
-	<p>Before releasing a new version of a gem, it is a great idea to install the gem locally and do some sanity checks. You know, to limit the chance of you looking like a noob.</p>
-
-
-<pre>rake local_deploy</pre>
-
-	<p>This generates the website into your website folder, and locally installs the gem, ready for testing and local use.</p>
-
-
 	<h3>Change the gems version number</h3>
 
 
 	<p>The version number is set in the file <code>lib/#gem name#/version.rb</code>. Update it as appropriate with major, minor and bug fix numbers. This value will be used when generating your website, for example.</p>
 
@@ -169,18 +158,21 @@
 <pre>rake check_manifest</pre>
 
 	<p>The results show a <em>diff</em> of the two.</p>
 
 
-	<h3>Installation</h3>
+	<h2>Package and test locally</h2>
 
 
-<pre>rake install_gem</pre>
+	<p>Before releasing a new version of a gem, it is a great idea to install the gem locally and do some sanity checks. You know, to limit the chance of you looking like a noob.</p>
 
-	<p>This will repackage your code as a gem and install it as a local gem with the new version number.</p>
 
+<pre>rake local_deploy</pre>
 
+	<p>This generates the website html files into your website folder, and locally installs the gem, ready for testing and local use.</p>
+
+
 	<p>Now pretend to be a user, and do some tests &#8211; especially of new functionality &#8211; so you are comfortable all the files have been packaged up, and you haven&#8217;t missed anything in the <code>Manifest.txt</code>.</p>
 
 
 	<p>One set of tests you should do is to repeat any tutorials you include in your website. If your gem is dependent on other gems that are rapidly changing, its possible your tutorial might be invalid even if your unit tests are successful. Best you find any errors before the users start emailing you!</p>
 
@@ -204,57 +196,73 @@
 
 
 	<p>Between each version of your gem, you probably changed something. You should document this in the <code>History.txt</code> file. For each new release, you need to add two paragraphs that look like this:</p>
 
 
-<pre>+++ 0.5.4 14/4/2007
+<pre>== 0.5.4 14/4/2007
 
-+ 1 major improvement
-    + 150% more Wizzos
-+ 2 bug fixes
-    + Wizzos are the proper colour
-    + You only get Wizzos when you ask for them
+* 1 major improvement
+  * 150% more Wizzos
+* 2 bug fixes
+  * Wizzos are the proper colour
+  * You only get Wizzos when you ask for them
 </pre>
 
 	<p>The two paragraphs will be automatically picked up by the following release process and documented against the release on RubyForge site. To see an example of the end result, look at the <a href="http://rubyforge.org/frs/shownotes.php?release_id=9695"><strong>Changes</strong> section for hoe 1.2</a>.</p>
 
 
 	<p>The History.txt notes for your first release have already been started for you.</p>
 
 
-	<h3>Generate and upload the website</h3>
+	<h3>Release the gem and upload the website and rdocs</h3>
 
 
-	<p>The rake task <code>rake website_upload</code> will upload the website into a RubyForge project.</p>
+	<p>Run <code>rake deploy VERSION=X.Y.Z</code> after you&#8217;ve done all these steps. It does the following:</p>
 
 
-	<p>Or use the task <code>rake website</code>, which performs both the generation and the upload.</p>
+	<ol>
+	<li>Uploads your website to rubyforge</li>
+		<li>Uploads your rdocs to rubyforge</li>
+		<li>Packages and uploads your gem to RubyForge</li>
+	</ol>
 
 
-	<h3>Release the gem</h3>
+	<p>It can take an hour or two before new gem releases are available via the gem installer. But when they are ready, everyone will be able to download and install your gem using:</p>
 
 
-	<p>Run <code>rake deploy VERSION=X.Y.Z</code> after you&#8217;ve done all these steps, and your gem will be repackaged and released to RubyForge, <span class="caps">PLUS</span> your website will be released with the latest version number.</p>
+<pre>sudo gem install #gem_name#</pre>
 
+	<p>If your <span class="caps">GEM</span>_NAME and <span class="caps">RUBYFORGE</span>_PROJECT name are the same, then:</p>
 
-	<p>It can take an hour or two before new gem releases are available via the gem installer. But when they are ready, everyone will be able to download and install your gem using:</p>
 
+	<ul>
+	<li>http://RUBYFORGE_PROJECT.rubyforge.org is your website, and</li>
+		<li>http://RUBYFORGE_PROJECT.rubyforge.org/rdoc is your rdocs</li>
+	</ul>
 
-<pre>sudo gem install #gem_name#</pre>
 
+	<p>If they are different, then:</p>
+
+
+	<ul>
+	<li>http://RUBYFORGE_PROJECT.rubyforge.org/GEM_NAME is your website, and</li>
+		<li>http://RUBYFORGE_PROJECT.rubyforge.org/GEM_NAME/rdoc is your rdocs</li>
+	</ul>
+
+
 	<h2>Bonus tasks thanks to Hoe</h2>
 
 
-	<p>Your gem uses the Hoe gem to provide a dozen or so useful rake tasks for managing your gem, such as <code>release</code>.</p>
+	<p>Your gem uses the Hoe gem to provide a dozen or so useful rake tasks for managing your gem, such as <code>release</code>, <code>check_manifest</code> and <code>publish_docs</code>.</p>
 
 
 	<p>See them all with:</p>
 
 
 <pre>rake -T</pre>
 
-	<p>Remember, the Rakefile is yours to extend as you please with more rake tasks, such as the <code>website</code> tasks already added.</p>
+	<p>Remember, the Rakefile is yours to extend as you please with more rake tasks, such as the <code>website</code> tasks which are already added.</p>
 
 
 	<p>For more information about each task, see the <a href="http://seattlerb.rubyforge.org/hoe/">Hoe <span class="caps">README</span></a></p>
 
 
@@ -288,10 +296,10 @@
 	<h2>Contact</h2>
 
 
 	<p>Comments are welcome. Send an email to <a href="mailto:drnicwilliams@gmail.com">Dr Nic Williams</a>.</p>
     <p class="coda">
-      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 20th May 2007<br>
+      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 24th May 2007<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>
 
 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">