svn commit: r1626816 - /cordova/site/README.md

[ma...@apache.org]

Author: marcelk
Date: Mon Sep 22 16:15:31 2014
New Revision: 1626816

URL: http://svn.apache.org/r1626816
Log:
Add missing steps for generating website, especially blog posts

Modified:
    cordova/site/README.md

Modified: cordova/site/README.md
URL: http://svn.apache.org/viewvc/cordova/site/README.md?rev=1626816&r1=1626815&r2=1626816&view=diff
==============================================================================
--- cordova/site/README.md (original)
+++ cordova/site/README.md Mon Sep 22 16:15:31 2014
@@ -35,12 +35,13 @@ How to compile the site
     # change to the cordova website directory.
     $ cd /path/to/cordova-website
 
-    # compile the site.
+    # compile the site. Note that if you change a blog entry (i.e., grunt updateBlog), you will need to re-run "rake build".
     $ rake build
 
     # the site is generated in `public/` with an index.html file that
     # can be opened using:
     $ rake serve
+    # and pointing your browser at localhost:4000
 
 
 Where to make changes
@@ -52,7 +53,7 @@ The files that are served by cordova.apa
 Some files live only in public/, and changes to them should be made directly. The
 list of these can be found in _config.yml.
 
-How to update the docs
+How to update the docs part of the website
 ----------------------
 
     # render the docs following the directions in the `cordova-docs` repository.
@@ -88,20 +89,33 @@ Writing a Blog Post
 
 Use the grunt scripts!
 
-    # Clone apche-blog-posts repo
+    # Clone apache-blog-posts repo if you haven't already
     $ grunt cloneBlog
 
-    # Create your blog posts in the apache-blog-posts (or on github) directory, git commit changes
+    # Create your blog posts in the apache-blog-posts (or on github) directory, and share with other for review via `git commit`. If creating a new md file, use an earlier one as a template.
 
-    # Edit your md file to remove undesired markdown links. If there is a phrase in square brackets that isn't a CB-xxxx reference, escape it with backslashes
-    [CB-1234] \[iOS\] \[Camera\] add a whizzbang to the brickit
+    # pull down the latest shared edits of apache-blog-posts
+    git pull
 
-    # Set a marker where the summary on the home page should stop displaying. Add the following line to your md file at the desired point:
+    # Edit your md file to remove undesired markdown links. If there is a phrase in square brackets that isn't a CB-xxxx reference, escape it with backslashes. Otherwise, heruko might error out and fail to build all the html.
+    [CB-1234] \[iOS\] \[Camera\] add a whizzbang to the snarfblat
+
+    # Set a marker where the summary on the home page should stop displaying. Add the following html comment line to your md file at the desired cutoff point:
     <!--more-->
+
+    # git commit your changes to apache-blog-posts
     
     # copy blog www/_posts directory + linkify
     $ grunt updateBlog
 
+    # preview it locally
+    cd ..
+    rake build
+    rake serve
+
+    # add the full text of your new generate blog entry to svn
+    svn add public/announcements/2014/09/08/cordova-361.html
+    svn commit
 
 **Types of Posts**