You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2014/04/07 20:30:49 UTC
[4/4] git commit: [doc] Update README.md with Heroku instructions.
[doc] Update README.md with Heroku instructions.
Project: http://git-wip-us.apache.org/repos/asf/cordova-labs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-labs/commit/9608718f
Tree: http://git-wip-us.apache.org/repos/asf/cordova-labs/tree/9608718f
Diff: http://git-wip-us.apache.org/repos/asf/cordova-labs/diff/9608718f
Branch: refs/heads/docs-cordova-io
Commit: 9608718f914873770edaa3c7b62e13b1f4ef386f
Parents: dd25530
Author: Michael Brooks <mi...@michaelbrooks.ca>
Authored: Mon Apr 7 11:25:19 2014 -0700
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Mon Apr 7 11:25:19 2014 -0700
----------------------------------------------------------------------
README.md | 50 ++++++++++++++++++++++++++++----------------------
1 file changed, 28 insertions(+), 22 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-labs/blob/9608718f/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index ec7d345..3c18a3a 100644
--- a/README.md
+++ b/README.md
@@ -1,40 +1,46 @@
# Cordova Documentation Redirect Server
-## Redirects
+## Redirect Logic
- Request Redirect
- ---------------------------------------
- / | /en/VERSION/index.html
- /some/path/ | /some/path/
+ Request | Type | Redirect
+ -------------|--------|----------------
+ / | 302 | /en/VERSION/index.html
+ /some/path/ | 302 | /some/path/
-## Setup
+## Contribute
-### DNS
+### Install
-__Name:__ `docs.cordova.io`
+1. Install [Heroku Toolkit](https://toolbelt.heroku.com/)
+1. `$ npm install`
-__Url:__ `http://mwbrooks.redirect-docs-cordova-io.jit.su`
+### Updating Homepage Version
-__Redirect Type:__ 302
+ $ echo 2.5.0 > VERSION
+ $ git commit -am "Default redirect to version 2.5.0"
-### Hosting
+### Start Server
-__Service:__ [Nodejitsu](http://nodejitsu.com)
+ $ npm start
-__Account:__ mwbrooks (Michael Brooks)
+### Deploy to Heroku
-__URL:__ [http://mwbrooks.redirect-docs-cordova-io.jit.su/](http://mwbrooks.redirect-docs-cordova-io.jit.su/)
+ # Sanity test that Heroku Procfile works
+ $ foreman start
-## Usage
+ # Add Heroku remote repository
+ $ git remote add heroku git@heroku.com:docs-cordova-io.git
-### Deployment
+ # Heroku must deploy from master branch
+ $ git push heroku docs-cordova-io:master
- $ jitsu deploy
+## Heroku Details
-### Updating Default Version
+- Project: [docs-cordova-io](https://dashboard.heroku.com/apps/docs-cordova-io/resources)
+- Git Repo: [git@heroku.com:docs-cordova-io.git](git@heroku.com:docs-cordova-io.git)
+- Owner: Michael Brooks <mi...@michaelbrooks.ca>
- $ echo 2.5.0 > VERSION
-
- $ git commit -am "Default redirect to version 2.5.0"
+To become a collaborator to the Heroku project:
- $ jitsu deploy
+- Sign up for a [Heroku account](http://heroku.com)
+- Email dev@cordova.apache.org and provide your Heroku account