Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial Edit Suggestions to Nodejitsu's Handbook #20

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 21 additions & 0 deletions ReadMe.md
Expand Up @@ -176,6 +176,27 @@ managing your applications


Each of these tools allow developers to access the exact same functionality. Each of these tools allow developers to access the exact same functionality.


## Multi-Version node support

Nodejitsu allows users to choose which version of node they want their application to run on. This means that not only do we now support v0.6, but also that users may continue to use v0.4 if they would like.

In order to set your node version, specify it in your `package.json`'s "engines" field. For example:

{
"author": "Nodejitsu <josh@nodejitsu.com>",
"version": "0.1.0",
"scripts": {
"start": "node bin/server"
},
"analyze": false,
"name": "helloworld",
"engines": {
"node": "v0.6.x"
}
}

If no node engine is specified, nodejitsu will default to v0.4.12.

## Snapshots ## Snapshots
<a name='features/snapshots'></a> <a name='features/snapshots'></a>


Expand Down
2 changes: 1 addition & 1 deletion chapters/haibu.md
Expand Up @@ -8,7 +8,7 @@ developers.


By installing haibu, a user creates a development environment for themselves By installing haibu, a user creates a development environment for themselves
that mirrors the functionality of Nodejitsu's cloud platform! Any project that that mirrors the functionality of Nodejitsu's cloud platform! Any project that
can be deployed on Nodejitsu can be ran by haibu. can be deployed on Nodejitsu can be run by haibu.


Haibu, which is Japanese for "hive", wraps node.js applications in a "carapace" Haibu, which is Japanese for "hive", wraps node.js applications in a "carapace"
and converts them into managed "drones". This approach allows haibu to directly and converts them into managed "drones". This approach allows haibu to directly
Expand Down
14 changes: 11 additions & 3 deletions chapters/hello_world.md
Expand Up @@ -8,7 +8,7 @@ Before you get started, you should have both
[node.js](https://github.com/joyent/node/wiki) and the [node.js](https://github.com/joyent/node/wiki) and the
[Node Package Manager](https://github.com/isaacs/npm/#readme) (npm) installed. [Node Package Manager](https://github.com/isaacs/npm/#readme) (npm) installed.


## Write A Server: ## Write A Server


Let's start with a very basic Node.js http server. Create a folder called Let's start with a very basic Node.js http server. Create a folder called
`myapp/` and then create a file inside the folder called `server.js`. Inside `myapp/` and then create a file inside the folder called `server.js`. Inside
Expand All @@ -32,11 +32,14 @@ this file, write the following code:
res.end(); res.end();
}).listen(80); // the server will listen on port 80 }).listen(80); // the server will listen on port 80



That's all the code you'll need for starters. Save your server and get ready to That's all the code you'll need for starters. Save your server and get ready to
deploy! deploy!


## Deploy with Jitsu: For more information on setting up a basic HTTP server, handling simple server requests,
and routing these requests using Node.js, [here](http://www.nodebeginner.org/) is a guide
to help you dive a bit deeper.

## Deploy with Jitsu


In this tutorial, we will use [jitsu](http://github.com/nodejitsu/jitsu) to deploy In this tutorial, we will use [jitsu](http://github.com/nodejitsu/jitsu) to deploy
our "hello world" application. Jitsu is a our "hello world" application. Jitsu is a
Expand Down Expand Up @@ -95,3 +98,8 @@ Now just open up your favorite browser, and go to
`yoursubdomain.nodejitsu.com`. If everything has been set up correctly, then `yoursubdomain.nodejitsu.com`. If everything has been set up correctly, then
you, too, are on the path of nodejitsu! you, too, are on the path of nodejitsu!


If for some reason your first 'jitsu deploy' command returns an error, try entering the command again.
If you're given an error again, join our chanel on [freenode](http://webchat.freenode.net/) at
[irc://irc.freenode.net/#nodejitsu](irc://irc.freenode.net/#nodejitsu) and we'd be happy to help you
troubleshoot your problem.

12 changes: 4 additions & 8 deletions chapters/introduction.md
Expand Up @@ -20,21 +20,17 @@ You can find our open source projects at <https://github.com/nodejitsu>, <https:


## What Is Nodejitsu? ## What Is Nodejitsu?


[Nodejitsu](http://nodejitsu.com/) is a Platform as a Service and a Marketplace [Nodejitsu](http://nodejitsu.com/) is a [Platform as a Service](http://en.wikipedia.org/wiki/Platform_as_a_service) and a Marketplace for Node.js applications. Nodejitsu allows you to seamlessly deploy your Node.js applications into the cloud with a myriad of additional features. Our platform provides a robust suite of functionality to assist in the development, management, and deployment of Node.js applications. Our team is firmly devoted to creating the most user-friendly tools in the industry and to providing the most enjoyable and helpful customer support experience possible.
for Node.js applications. Nodejitsu allows you to seamlessly deploy your Node.js
applications into the cloud with a myriad of additional features. Our platform Note: The Marketplace is coming soon! It will be an online store where you can browse ready to deploy Node.js Applications. The Marketplace will be a great place to start if you are new to Node.js development or want to share your existing Node.js Application with the world.
provides a robust suite of functionality to assist in the development,
management, and deployment of Node.js applications. Our deployment tools are the
most user-friendly in the industry and our customer support is unparalleled.


## Getting Started ## Getting Started


So you wish to learn the ways of Nodejitsu? Excellent! You only need to know So you wish to learn the ways of Nodejitsu? Excellent! You only need to know
three things to get started: three things to get started:


* We're [Nodejitsu](http://nodejitsu.com), and we can give you scalable, * We're [Nodejitsu](http://nodejitsu.com), and we can give you scalable,
fault-tolerant cloud hosting for your Node.js apps - and we're the best you'll fault-tolerant cloud hosting for your Node.js apps. We are dedicated to making sure our customers and other developers have an exceptional experience using our platform and open source software.
find.


* Getting started with [your first app](#hiworld) is simple with our * Getting started with [your first app](#hiworld) is simple with our
[jitsu](#jitsu) command-line interface - we'll [show you how](#hiworld). [jitsu](#jitsu) command-line interface - we'll [show you how](#hiworld).
Expand Down
2 changes: 1 addition & 1 deletion chapters/jitsu.md
Expand Up @@ -94,7 +94,7 @@ do so.


### jitsu config <action> ### jitsu config <action>


`jitsu config` commands allow you to edit your local jitsu confuration file. `jitsu config` commands allow you to edit your local jitsu configuration file.


### jitsu snapshots <action> ### jitsu snapshots <action>


Expand Down
7 changes: 5 additions & 2 deletions chapters/platform_features.md
Expand Up @@ -26,14 +26,17 @@ environment.
## Databases ## Databases
<a name='features/databases'></a> <a name='features/databases'></a>


Applications on Nodejitsu are ready to be connected to any database. If you have already have a database running, Nodejitsu can connect to your pre-existing database. If you require a new database, Nodejitsu can provide you *free* instances of several different types of databases. These free instances are great for development purposes or hobby sites. If you require a high traffic or production database we provide an easy upgrade path to industrial strength database hosting. Applications on Nodejitsu are ready to be connected to any database. If you already have a database running, Nodejitsu can connect to your pre-existing database. If you require a new database, Nodejitsu can provide you *free* instances of several different types of databases. These free instances are great for development purposes or hobby sites. If you require a high traffic or production database we provide an easy upgrade path to industrial strength database hosting.


### Creating new Databases ### Creating new Databases


If you require database hosting you can create a new database instance of any If you require database hosting you can create a new database instance of any
of our supported databases using [jitsu](#jitsu), the of our supported databases using [jitsu](#jitsu), the
[Nodejitsu Web Application](#webapp), or Nodejitsu's [API](#api). Cloud [Nodejitsu Web Application](#webapp), or Nodejitsu's [API](#api). Cloud
database hosting is currently provided by CouchOne, Redis2Go and MongoHQ. database hosting is currently provided by [Couchbase](http://www.couchbase.com/), [Redis2Go](http://redis.io/) and [MongoHQ](https://mongohq.com/home).

See "Databases" in the "JSON API" section below for further information on how to create a new
Database.


### Existing Databases ### Existing Databases


Expand Down
2 changes: 1 addition & 1 deletion chapters/support.md
Expand Up @@ -16,7 +16,7 @@ If you have issues, you can always contact us via email, at
Nodejitsu has a channel on [freenode](http://webchat.freenode.net/) at Nodejitsu has a channel on [freenode](http://webchat.freenode.net/) at
<a href="irc://irc.freenode.net/#nodejitsu">irc://irc.freenode.net/#nodejitsu</a>, where Nodejitsu <a href="irc://irc.freenode.net/#nodejitsu">irc://irc.freenode.net/#nodejitsu</a>, where Nodejitsu
developers are standing by to support users around the clock. Drop by to ask developers are standing by to support users around the clock. Drop by to ask
questions, get assistance or even just to hang out! questions, get assistance, or even just to hang out!


## Github Issues ## Github Issues


Expand Down