incubator-callback-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwbro...@apache.org
Subject docs commit: [#590] Update installation steps to avoid markdown errors.
Date Tue, 17 Jul 2012 15:36:24 GMT
Updated Branches:
  refs/heads/master f07420560 -> 91231e3e9


[#590] Update installation steps to avoid markdown errors.


Project: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/commit/91231e3e
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/tree/91231e3e
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/diff/91231e3e

Branch: refs/heads/master
Commit: 91231e3e93932f1012d56a8b8a20e5ccd8520c87
Parents: f074205
Author: Michael Brooks <michael@michaelbrooks.ca>
Authored: Tue Jul 17 08:36:13 2012 -0700
Committer: Michael Brooks <michael@michaelbrooks.ca>
Committed: Tue Jul 17 08:36:13 2012 -0700

----------------------------------------------------------------------
 README.md |   52 ++++++++++++++++++++++++++++++++++------------------
 1 files changed, 34 insertions(+), 18 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/91231e3e/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 741b8ac..7ff1ece 100644
--- a/README.md
+++ b/README.md
@@ -85,9 +85,15 @@ Each language can override the default template in `template/docs/LANGUAGE`.
 Generating the Documentation
 ----------------------------
 
+### Quick Preview
+
+When making minor edits, it is usually safe to simply render the edited from
+Markdown to HTML. Many code editors have plugins to render Markdown to HTML
+and there are a handful of [good](http://dillinger.io/) online editors.
+
 Currently, a Ruby script and [joDoc](http://github.com/davebalmer/jodoc) are used to generate
the HTML documentation.
 
-### Install joDoc ###
+### Install joDoc
 
 - Clone [joDoc](http://github.com/davebalmer/jodoc)
 
@@ -103,8 +109,6 @@ Currently, a Ruby script and [joDoc](http://github.com/davebalmer/jodoc)
are use
 
         # Use your package manager
         brew install markdown
-        port install markdown
-        aptitude install markdown
 
 - Install nokogiri (Ruby HTML parser)
 
@@ -114,29 +118,41 @@ Currently, a Ruby script and [joDoc](http://github.com/davebalmer/jodoc)
are use
 
         gem install json
 
-### Run the Script ###
+### Run the Script
 
     ./bin/generate
+
+### Problems
     
-Script Test Suite
------------------
+Generated a Version Release
+---------------------------
 
-__Install rspec:__
+There is a Rake task to increment the version, generate the version directory, and update
the edge documentation.
 
-    gem install rspec --version 1.3.0
-    
-__Run all specs:__
+    # generate version 1.7.0
+    rake version[1.7.0]
 
-    rake
+FAQ
+---
 
-__Run a specific spec:__
+### Error while running `./bin/generate`
 
-    spec spec/phonegap/add_title_spec.rb
+If you get the following error:
 
-Generated a Version Release
----------------------------
+    ./bin/../lib/cordova/navigation_menu.rb:14:in `read': can't convert nil into String (TypeError)
+        from ./bin/../lib/cordova/navigation_menu.rb:14:in `initialize'
+        from ./bin/../lib/docs_generator.rb:86:in `new'
+        from ./bin/../lib/docs_generator.rb:86:in `after_jodoc'
+        from ./bin/../lib/docs_generator.rb:55:in `run'
+        from ./bin/../lib/docs_generator.rb:45:in `foreach'
+        from ./bin/../lib/docs_generator.rb:45:in `run'
+        from ./bin/../lib/docs_generator.rb:41:in `foreach'
+        from ./bin/../lib/docs_generator.rb:41:in `run'
+        from ./bin/generate:6
 
-There is a Rake task to increment the version, generate the version directory, and update
the edge documentation.
+You may need to add the following line to the joDoc script:
+
+    $markdown_bin = "/path/to/Markdown.pl";
+
+For more details, see the [Issue #590](https://issues.apache.org/jira/browse/CB-590).
 
-    # generate version 1.7.0
-    rake version[1.7.0]
\ No newline at end of file


Mime
View raw message