Permalink
Browse files

Refactored to use the new wycats/guides gem

  • Loading branch information...
1 parent 2a0d7e6 commit 1907944a418f48fd1e3166bdb48ab657fcae70b4 @schof schof committed May 29, 2011
Showing 1,022 changed files with 986 additions and 107,861 deletions.
View
@@ -1,3 +1,3 @@
source :gemcutter
-gem 'RedCloth', '~> 4.2.3'
+gem 'guides'
View
@@ -1,26 +1,37 @@
SUMMARY
=======
-This project serves as the basis for the online documentation effort for the [Spree ecommerce project](http://spreecommerce.com). 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/railsdog/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.
+This project serves as the basis for the online documentation effort for the [Spree ecommerce project](http://spreecommerce.com). 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.
+
+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>
- $ git clone git://github.com/railsdog/spree-guides.git
- $ cd spree guides
- $ rake guides
+ $ git clone git://github.com/spreee/spree-guides.git
+ $ cd spree-guides
+ $ bundle install
+ $ guides build
</code></pre>
-
-You will also need to install the RedCloth gem (4.2.3 or greater) if you do not have it. Output will be generated in the `output` directory.
-To build just one file, say checkout.textile , you can run the spree_guides.rb with an extra argument like below.
+You can force a rebuild of all of the guides using
-<pre><code>
- $ ruby spree_guides.rb checkout
-</code></pre>
+```
+$ guides build --clean
+```
+
+You can also specify that you want to rebuild just a few of the guides
+
+```
+$ guides build --only=checkout adjustments
+```
+
+Finally, you can also preview the guides while you work
+
+```
+$ guides preview
+```
-You do not need to fork the spree-guides project in order to contribute. Just send an email to [spree-user](http://groups.google.com/group/spree-user) (be sure to include your github username) and say that you would like to contribute. We'll add you to the list so you can commit directly to the guides project.
+You do not need to fork the spree-guides project in order to contribute. Just send an email to [spree-user](http://groups.google.com/group/spree-user) (be sure to include your github username) and say that you would like to contribute. We'll add you to the list so you can commit directly to the guides project.
Please be considerate when making changes to the spree-guides. If you wish to make major changes to how the documentation is organized then you should use a GitHub fork and ask people to review your proposed changes instead.
View
@@ -1,9 +0,0 @@
-require "rubygems"
-require "bundler/setup"
-
-desc 'Generate guides (for authors), use ONLY=foo to process just "foo.textile"'
-task :guides do
- ruby "spree_guides.rb"
-end
-
-task :default => :guides
Oops, something went wrong.

0 comments on commit 1907944

Please sign in to comment.