Improved guide organization and added placeholders for several new ones.

spree · Apr 29, 2009 · 236ab9a · 236ab9a
1 parent 1234784
commit 236ab9a
Show file tree

Hide file tree

Showing 7 changed files with 215 additions and 13 deletions.
diff --git a/LICENSE b/LICENSE
diff --git a/README.markdown b/README.markdown
@@ -0,0 +1,17 @@
+SUMMARY
+=======
+
+This project serves as the basis for the online documentation effort for the [Spree](http://spreecommerce.com) ecommerce project.  The documentation has been graciously donated by members of our online community.  This work is licensed under the [Creative Commons Attribution-Share Alike 3.0 ](http://creativecommons.org/licenses/by-sa/3.0/) license.  Contributions are encouraged.  Please ask [Sean Schofield](http://github.com/schof) for commit access if you have something to contribute.  If you are thinking about a new guide or major changes to the organization of the existing guides, please be courteous and do this in your own fork so it can be dicussed before merging. 
+
+The guides are written in [Textile]() and there is information on the [spree-guides wiki](http://wiki.github.com/schof/spree-guides) on the general style to use when writing a guide.  Please stick to the established format and feel free to ask questions on [spree-user](http://groups.google.com/group/spree-user) or #spree if you have any questions. 
+
+To build the entire set of guides simply run the following command
+
+<pre><code>
+  rake guides
+</code></pre>
+            
+Output will be generated in the `output` directory.
+
+Spree is a complete open source commerce solution for Ruby on Rails.  It was developed by [Sean Schofield](http://railsdog.com) in an effort to build a superior ecommerce platform for the Rails community.  Please see the [spree ecommerce project](http://spreecomerce.com) for more details.
+
diff --git a/source/index.erb.textile b/source/index.erb.textile
@@ -16,9 +16,115 @@ These guides are designed to make you immediately productive with Spree, and to
 h3. Start Here
 
 <dl>
-<% guide('Getting Started with Spree', 'getting_started.html') do %>
-  Everything you need to know to install Spree and create your first application.
-<% end %>
+  <% guide('Getting Started with Spree', 'getting_started.html') do %>
+    Everything you need to know to install Spree and create your first application.
+  <% end %>       
+</dl>
+<dl>
+  <% guide('Server Configuration', 'server_configuration.html') do %>
+    Steps to get your Spree application up and running in a production environment.
+  <% end %>
+</dl>
+
+h3. Basic Configuration
+
+<dl>
+  <% guide('Zones', 'zones.html') do %>
+    This guide covers how to configure a zone for shipping, taxation or other custom purposes.
+  <% end %>
+</dl>
+<dl>
+  <% guide('Taxation', 'taxation.html') do %>
+    Information on how to configure the tax calculations for your site (including Sales Tax and VAT.)
+  <% end %>
+</dl>
+<dl>
+  <% guide('Pricing', 'pricing.html') do %>
+    This guide covers how to configure pricing information for your store.
+  <% end %>
+</dl>
+<dl>
+  <% guide('Inventory', 'inventory.html') do %>
+    Information on the powerful inventory management system used by Spree.
+  <% end %>
+</dl>
+<dl>
+  <% guide('Payment Gateways', 'payment_gateways.html') do %>
+    This guide covers how to setup a payment gateway using ActiveMerchant or another gateway solution of your choice.
+  <% end %>
+</dl>
+<dl>
+  <% guide('Shipping', 'shipping.html') do %>
+    Information on how to configure shiping options as well as building your own shipping calculator.
+  <% end %>
+</dl>
+<dl>
+  <% guide('Taxonomy/Categories', 'taxonomy.html') do %>
+    This guide covers various methods for categorizing your products.
+  <% end %>
+</dl>
+
+h3. Customization
+
+<dl>
+  <% guide('Using Extensions', 'extension_overview.html') do %>
+    This guide covers how to use the extension system to customize Spree to meet your exact needs.
+  <% end %>
+</dl>
+<dl>
+  <% guide('Extension Tutorial', 'extension_tutorial.html') do %>
+    This tutorial covers the basic steps of creating your own custom extension.
+  <% end %>
+</dl>
+
+h3. Digging Deeper
+
+<dl>
+  <% guide('Internationalization/Localization', 'i18n.html') do %>
+    This guide covers issues related to using Spree in different countries and locales.
+  <% end %>
+</dl>
+<dl>
+  <% guide('Boot Modes', 'boot_modes.html') do %>
+    Information on the different modes in which you can run Spree.
+  <% end %>
+</dl>
+<dl>
+  <% guide('Testing Spree Applications', 'testing.html') do %>
+    This guide covers how to test the Spree source code as well as how to write new tests. 
+  <% end %>
+</dl>
+<dl>
+  <% guide('Securing Spree Applications', 'security.html') do %>
+    Information on how to secure your Spree application (including roles and permisions settings.)
+  <% end %>
+</dl>
+<dl>
+  <% guide('Customizing the Checkout Process', 'checkout.html') do %>
+    This guide covers how to customize the checkout process to meet your own requirements.
+  <% end %>
+</dl>
+<dl>
+  <% guide('Preferences', 'preferences.html') do %>
+    Information on how to administer the various preferences in Spree.
+  <% end %>
+</dl>
+<dl>
+  <% guide('Contributing to Spree', 'contributing_to_spree.html') do %>
+    Do you enjoy Spree and want to "give something back?"  This guide contains information on how to contribute to the Spree project.  
+  <% end %>
+
+h3. Best Practices   
+
+<dl>
+  <% guide('Upgrade Considerations', 'upgrade_considerations.html') do %>
+    This guide covers how to design your Spree project so as to minimize problems should you decide to upgrade to a newer version.
+  <% end %>
+</dl>
+<dl>
+  <% guide('SEO Considerations', 'seo_considerations.html') do %>
+    Information on how to leverage the exisitng SEO features of Spree as well general SEO best practices.
+  <% end %>
 </dl>
 
 <% end %>

diff --git a/source/layout.html.erb b/source/layout.html.erb
@@ -16,11 +16,11 @@
 <body class="guide">
   <div id="topNav">
     <div class="wrapper">
-      <strong>More at <a href="http://spreehq.org/">spreehq.org:</a> </strong>
-      <a href="http://spreehq.org/features">Features</a> |
-      <a href="http://spreehq.org/screenshots">Screenshots</a> |
-      <a href="http://spreehq.org/demo">Demo</a> |
-      <a href="http://spreehq.org/support">Support</a>
+      <strong>More at <a href="http://spreecommerce.com">spreecommerce.com:</a> </strong>
+      <a href="http://spreecommerce.com/features">Features</a> |
+      <a href="http://spreecommerce.com/screenshots">Screenshots</a> |
+      <a href="http://spreecommerce.com/demo">Demo</a> |
+      <a href="http://spreecommerce.com/support">Support</a>
     </div>
   </div>
   <div id="header">
@@ -35,28 +35,34 @@
             <dl class="L">
               <dt>Start Here</dt>
               <dd><a href="getting_started.html">Getting Started with Spree</a></dd>
+              <dd><a href="server_configuration.html">Server Configuration</a></dd>
               <dt>Basic Configuration</dt>
               <dd><a href="zones.html">Zones</a></dd>
               <dd><a href="taxation.html">Taxation</a></dd>
               <dd><a href="pricing.html">Pricing</a></dd>
               <dd><a href="inventory.html">Inventory</a></dd>
               <dd><a href="payment_gateways.html">Payment Gateways</a></dd>
               <dd><a href="shipping.html">Shipping</a></dd>              
-              <dd><a href="taxonomy.html">Taxonomy/Categorization</a></dd>              
-              <dt>Extensions</dt>
-              <dd><a href="extension_overview.html">Extension Overview</a></dd>
+              <dd><a href="taxonomy.html">Taxonomy/Categories</a></dd>              
+              <dt>Customization</dt>
+              <dd><a href="extension_overview.html">Using Extensions</a></dd>
               <dd><a href="extension_tutorial.html">Extension Tutorial</a></dd>
             </dl>
             <dl class="R">
               <dt>Digging Deeper</dt>
-              <dd><a href="i18n.html">Spree Internationalization</a></dd>
+              <dd><a href="i18n.html">Internationalization/Localization</a></dd>
               <dd><a href="boot_modes.html">Boot Modes</a></dd>
               <dd><a href="testing.html">Testing Spree Applications</a></dd>
               <dd><a href="security.html">Securing Spree Applications</a></dd>
               <dd><a href="checkout.html">Customizing the Checkout Process</a></dd>
               <dd><a href="preferences.html">The Preference System</a></dd>
               <dd><a href="contributing_to_spree.html">Contributing to Spree</a></dd>
-            </dl>
+            </dl> 
+            <dl class="R">
+              <dt>Best Practices</dt>
+              <dd><a href="upgrade_considerations.html">Upgrade Considerations</a></dd>
+              <dd><a href="seo_considerations.html">SEO Considerations</a></dd>
+            </dl>            
           </div>
         </li>
         <li><a href="contribute.html">Contribute</a></li>

diff --git a/source/seo_considerations.textile b/source/seo_considerations.textile
@@ -0,0 +1,3 @@
+h2. SEO Considerations
+
+endprologue.
diff --git a/source/server_configuration.textile b/source/server_configuration.textile
@@ -0,0 +1,3 @@
+h2. Server Configuration
+
+endprologue.
diff --git a/source/upgrade_considerations.textile b/source/upgrade_considerations.textile
@@ -0,0 +1,3 @@
+h2. Upgrade Considerations
+
+endprologue.