From 42e3b6396f8c6f156ea4d6fdef341dfc074724cd Mon Sep 17 00:00:00 2001 From: Vijay Dev Date: Sat, 4 Feb 2012 17:04:27 +0530 Subject: mention how to generate guides for the Kindle [ci skip] --- .../source/ruby_on_rails_guides_guidelines.textile | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) (limited to 'railties/guides') diff --git a/railties/guides/source/ruby_on_rails_guides_guidelines.textile b/railties/guides/source/ruby_on_rails_guides_guidelines.textile index 29aefd25f8..f3c8fa654d 100644 --- a/railties/guides/source/ruby_on_rails_guides_guidelines.textile +++ b/railties/guides/source/ruby_on_rails_guides_guidelines.textile @@ -40,7 +40,9 @@ The guides and the API should be coherent where appropriate. Please have a look Those guidelines apply also to guides. -h3. HTML Generation +h3. HTML Guides + +h4. Generation To generate all the guides, just +cd+ into the +railties+ directory and execute: @@ -68,7 +70,7 @@ If you want to generate guides in languages other than English, you can keep the bundle exec rake generate_guides GUIDES_LANGUAGE=es -h3. HTML Validation +h4. Validation Please validate the generated HTML with: @@ -77,3 +79,13 @@ bundle exec rake validate_guides 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 way to fix them. + +h3. Kindle Guides + +h4. Generation + +To generate guides for the Kindle, you need to provide +KINDLE=1+ as an environment variable: + + +KINDLE=1 bundle exec rake generate_guides + -- cgit v1.2.3