Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Initial Edit Suggestions to Nodejitsu's Handbook #20

Closed
wants to merge 5 commits into from

4 participants

@tazrover

Included here are a few very simple, straightforward edits to the Handbook ReadMe.

I have a some additional, higher-level suggestions for places where added clarity and explanation would be very helpful (in my opinion) throughout this document. These would be easier to discuss directly with someone as I'm not an expert on some of this content yet and wouldn't be the best person to elaborate on the topics discussed.

I created a document with all my ideas that I can share and am happy to discuss further..

@hij1nx

These changes are somewhat trivial, but its a great start, please make a more substantial pull request and we'd be happy to spend the time reviewing! Thanks!

@jfhbrook

@tazrover The edits themselves look good. However, the readme.md is generated from content files using make. The file you want to edit is probably chapters/introduction.md.

If you make the edits there, we'll gladly accept as the proposed copy edits themselves look great.

@tazrover

@hij1nx Gotcha. Will do.

@tazrover

@jesusabdullah I see. Thanks for the heads up. I will make sure I make edits there when I add the rest of my suggestions.

@tazrover

@jesusabdullah @hij1nx I kept my edits to the .md files in /chapters. Hope you find these suggestions helpful. As I continue my research and feel I can help add more clarity to this document - I will make edits and open a new pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
This page is out of date. Refresh to see the latest.
View
21 ReadMe.md
@@ -176,6 +176,27 @@ managing your applications
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
<a name='features/snapshots'></a>
View
2  chapters/haibu.md
@@ -8,7 +8,7 @@ developers.
By installing haibu, a user creates a development environment for themselves
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"
and converts them into managed "drones". This approach allows haibu to directly
View
14 chapters/hello_world.md
@@ -8,7 +8,7 @@ Before you get started, you should have both
[node.js](https://github.com/joyent/node/wiki) and the
[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
`myapp/` and then create a file inside the folder called `server.js`. Inside
@@ -32,11 +32,14 @@ this file, write the following code:
res.end();
}).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
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
our "hello world" application. Jitsu is a
@@ -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
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.
+
View
12 chapters/introduction.md
@@ -20,12 +20,9 @@ You can find our open source projects at <https://github.com/nodejitsu>, <https:
## What Is Nodejitsu?
-[Nodejitsu](http://nodejitsu.com/) is a 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 deployment tools are the
-most user-friendly in the industry and our customer support is unparalleled.
+[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.
+
+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.
## Getting Started
@@ -33,8 +30,7 @@ So you wish to learn the ways of Nodejitsu? Excellent! You only need to know
three things to get started:
* 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
-find.
+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.
* Getting started with [your first app](#hiworld) is simple with our
[jitsu](#jitsu) command-line interface - we'll [show you how](#hiworld).
View
2  chapters/jitsu.md
@@ -94,7 +94,7 @@ do so.
### 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>
View
7 chapters/platform_features.md
@@ -26,14 +26,17 @@ environment.
## Databases
<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
If you require database hosting you can create a new database instance of any
of our supported databases using [jitsu](#jitsu), the
[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
View
2  chapters/support.md
@@ -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
<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
-questions, get assistance or even just to hang out!
+questions, get assistance, or even just to hang out!
## Github Issues
Something went wrong with that request. Please try again.