cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dblot...@apache.org
Subject [5/5] docs commit: Fixing up formatting in README. This closes #320.
Date Sat, 29 Aug 2015 01:05:13 GMT
Fixing up formatting in README. This closes #320.


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

Branch: refs/heads/cordova-website
Commit: df29b7429ede75bb2219e35bc92bbd56fd3e8680
Parents: 7ec41c3
Author: Dmitry Blotsky <dmitry.blotsky@gmail.com>
Authored: Fri Aug 28 18:04:38 2015 -0700
Committer: Dmitry Blotsky <dmitry.blotsky@gmail.com>
Committed: Fri Aug 28 18:04:44 2015 -0700

----------------------------------------------------------------------
 README.md | 32 +++++++++++++++-----------------
 1 file changed, 15 insertions(+), 17 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/df29b742/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 91446f6..bedc2dd 100644
--- a/README.md
+++ b/README.md
@@ -119,38 +119,31 @@ To add an item to the **Codorva Tools** or **Sample Cordova Apps** sections
on t
     1. Set the `image` field in the YAML file to be just the image file's *name*.
 1. Submit a GitHub pull request with the changes.
 
-Troubleshooting
-===============
-
-Ask for help on the IRC channel: #cordova on irc.freenode.net.
-
-***
-
 Writing a Blog Post
 ===================
 
 1. Pull down the latest website codebase for the current posts
 
-    git pull
+        git pull
 
 2. Create a new entry in the www/_posts directory.
 
 3. Use an earlier post an 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.
Otherwise, heruko might error out and fail to build all the html.
 
-    [CB-1234] \[iOS\] \[Camera\] add a whizzbang to the snarfblat
+        [CB-1234] \[iOS\] \[Camera\] add a whizzbang to the snarfblat
 
 4. 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-->
+        <!--more-->
+
+5. In the front matter of your blog entry, set the `date:` field to the desired date that
you want to appear near the title. Be aware that the date (explicit here or implied via the
filename) will be used to generate the relative path to this html file (e.g. "/announcements/2014/09/22/cordova-361.html"),
as will the `categories:` front matter value.
 
-5. In the front matter of your blog entry, set the `date:` field to the desired date that
you want to appear near the title. Be aware that the date (explicit here or implied via the
filename) will be used to generate the relative path to this html file (i.e., "/announcements/2014/09/22/cordova-361.html"),
as will the `categories:` front matter value.
-    
-    date: 2014-09-22
-    categories: releases
+        date: 2014-09-22
+        categories: announcements
 
-6. Run gulp link-bugs to linkify 
+6. Run gulp link-bugs to linkify
 
-    gulp link-bugs
+        gulp link-bugs
 
 7. Preview it locally by running the site using gulp
 
@@ -164,7 +157,6 @@ _Core Content_ - If the content has to do with cordova-core, or publishing
guide
 
 _Linked Posts_ - If the content was written by a contributor and is worth curating for the
whole community, but is not really core ie. non-core plugins, dev tips, research, opinion-pieces,
statistics, etc., post a short description, perhaps adding a document-snippet, but then link
to the externally hosted content, making it clearly not written by the organization.
 
-
 **Post guidelines:**
 
 * Use the post title as the first header.
@@ -184,6 +176,7 @@ _Linked Posts_ - If the content was written by a contributor and is worth
curati
 To get a summary of changes (and count the changes):
 
     for l in cordova-*; do ( cd $l ; git log --format="$(printf %30s $l) %s" --no-merges
--since='1 week ago' ) ; done | grep -iv version | grep -v CHANGELOG > all_logs.txt
+
 To get the number of authors:
 
     for l in cordova-*; do ( cd $l ; git log --format="%an" --no-merges --since='1 week ago'
) ; done | sort | uniq | wc -l
@@ -206,3 +199,8 @@ To print the list of plugin versions tested:
 [nodejs]: https://nodejs.org/
 [install_pip]: https://pip.pypa.io/en/latest/installing.html
 [svn]: http://svnbook.red-bean.com/en/1.7/svn.intro.quickstart.html
+
+Troubleshooting
+===============
+
+Ask for help on the IRC channel: #cordova on irc.freenode.net.


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org


Mime
View raw message