diff options
| author | Rafael Magana <raf.magana@gmail.com> | 2012-05-27 23:30:38 -0500 |
|---|---|---|
| committer | Rafael Magana <raf.magana@gmail.com> | 2012-05-27 23:30:38 -0500 |
| commit | 840e688dbff7274865f9ad787444b67881727a57 (patch) | |
| tree | cdf6034bcdfe5898c7bf004f0c1429f4d973e8f4 /guides/source/ruby_on_rails_guides_guidelines.textile | |
| parent | db57e6d12353e615af9f4078dc8590484b2444e8 (diff) | |
| download | rails-840e688dbff7274865f9ad787444b67881727a57.tar.gz rails-840e688dbff7274865f9ad787444b67881727a57.tar.bz2 rails-840e688dbff7274865f9ad787444b67881727a57.zip | |
[guides] update guides guidelines with the new generation and validation rake tasks
Diffstat (limited to 'guides/source/ruby_on_rails_guides_guidelines.textile')
| -rw-r--r-- | guides/source/ruby_on_rails_guides_guidelines.textile | 28 |
1 files changed, 23 insertions, 5 deletions
diff --git a/guides/source/ruby_on_rails_guides_guidelines.textile b/guides/source/ruby_on_rails_guides_guidelines.textile index f3e934d38c..d4b0fe9814 100644 --- a/guides/source/ruby_on_rails_guides_guidelines.textile +++ b/guides/source/ruby_on_rails_guides_guidelines.textile @@ -47,7 +47,13 @@ h4. Generation To generate all the guides, just +cd+ into the *+guides+* directory and execute: <plain> -bundle exec rake generate_guides +bundle exec rake guides:generate +</plain> + +or + +<plain> +bundle exec rake guides:generate:html </plain> (You may need to run +bundle install+ first to install the required gems.) @@ -56,7 +62,7 @@ To process +my_guide.textile+ and nothing else use the +ONLY+ environment variab <plain> touch my_guide.textile -bundle exec rake generate_guides ONLY=my_guide +bundle exec rake guides:generate ONLY=my_guide </plain> By default, guides that have not been modified are not processed, so +ONLY+ is rarely needed in practice. @@ -68,7 +74,13 @@ It is also recommended that you work with +WARNINGS=1+. This detects duplicate I If you want to generate guides in a language other than English, you can keep them in a separate directory under +source+ (eg. <tt>source/es</tt>) and use the +GUIDES_LANGUAGE+ environment variable: <plain> -bundle exec rake generate_guides GUIDES_LANGUAGE=es +bundle exec rake guides:generate GUIDES_LANGUAGE=es +</plain> + +If you want to see all the environment variables you can use to configure the generation script just run: + +<plain> +rake </plain> h4. Validation @@ -76,7 +88,7 @@ h4. Validation Please validate the generated HTML with: <plain> -bundle exec rake validate_guides +bundle exec rake guides:validate </plain> Particularly, titles get an ID generated from their content and this often leads to duplicates. Please set +WARNINGS=1+ when generating guides to detect them. The warning messages suggest a solution. @@ -88,5 +100,11 @@ h4(#generation-kindle). Generation To generate guides for the Kindle, you need to provide +KINDLE=1+ as an environment variable: <plain> -KINDLE=1 bundle exec rake generate_guides +KINDLE=1 bundle exec rake guides:generate +</plain> + +or you can use the following task: + +<plain> +bundle exec rake guides:generate:kindle </plain> |