Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

updates

  • Loading branch information...
commit 9fcd972a7c5e0fb11fff735dc117fa3560e45423 1 parent 1470fb2
Marak Marak authored
1  Makefile
View
@@ -62,5 +62,6 @@ clean:
clear:
rm -f chapters/*.html
+ rm -f pages/index.html
.PHONY: view clean regenerate
22 book.html
View
@@ -51,7 +51,7 @@ <h2 id="How-Can-I-Get-Started-">How Can I Get Started?</h2>
<li>Deploying from the API</li>
</ul>
</li>
-<li><a href="Using_The_Jitsu_Client.md">Using the Jitsu Client</a>
+<li><a href="#Using_The_Jitsu_Client" data-bare-link="true">Using the Jitsu Client</a>
<ul>
<li><a href="">Installation</a></li>
@@ -83,14 +83,14 @@ <h2 id="How-Can-I-Get-Started-">How Can I Get Started?</h2>
<li>Connecting existing Databases</li>
</ul>
</li>
-<li><a href="The_Marketplace.md">The MarketPlace</a>
+<li><a href="#The_Marketplace" data-bare-link="true">The MarketPlace</a>
<ul>
<li>Deploying a Marketplace Application</li>
<li>Getting your Application on the Marketplace</li>
</ul>
</li>
-<li><a href="Add_Ons.md">Add-Ons</a>
+<li><a href="#Add_Ons" data-bare-link="true">Add-Ons</a>
<ul>
<li>MailChimp</li>
@@ -98,7 +98,7 @@ <h2 id="How-Can-I-Get-Started-">How Can I Get Started?</h2>
<li>Adding your service as an add-on</li>
</ul>
</li>
-<li><a href="Open_source_Projects.md">Nodejitsu's Open-source Projects</a>
+<li><a href="#Open_source_Projects" data-bare-link="true">Nodejitsu's Open-source Projects</a>
<ul>
<li>Why open-source?</li>
@@ -114,7 +114,7 @@ <h2 id="How-Can-I-Get-Started-">How Can I Get Started?</h2>
<h1><p><a name="Deploying_Applications"></a></p>
Deploying Applications</h1>
-<p>TODO: add overview</p>
+<p>There are a few options for how you can deploy your Application to Nodejitsu.</p>
<ul>
<li><a href="#Samurai" data-bare-link="true">Deploying from the Samurai web admin</a></li>
@@ -195,8 +195,10 @@ <h2 id="Connecting-Applications-to-Databases">Connecting Applications to Databas
</div>
<div class='mp'>
-<h1>Using The Jitsu Client</h1>
-<p>Jitsu is a Command Line Tool (CLI) for interacting with the Nodejitsu platform. It's open-source and easy to use. We've designed Jitsu to be suitable for command line beginners, but still be powerful and extensible enough for production usage. If you aren't a fan of the command line, you can still pretty much do everything Jitsu can do through our web interface, Samurai.</p>
+<h1><p><a name="Using_The_Jitsu_Client"></a></p>
+
+Using The Jitsu Client</h1>
+<p><a href="http://github.com/nodejitsu/jitsu">Jitsu</a> is a <a href="http://en.wikipedia.org/wiki/Command-line_interface">Command Line Tool (CLI)</a> for interacting with the Nodejitsu platform. It's open-source and easy to use. We've designed Jitsu to be suitable for command line beginners, but still be powerful and extensible enough for production usage. If you aren't a fan of the command line or don't have terminal access, you can still do everything Jitsu can do through our web admin, <a href="#Samurai" data-bare-link="true">Samurai</a>.</p>
<ul>
<li><a href="">Installation</a></li>
@@ -219,7 +221,7 @@ <h2 id="Usage">Usage</h2>
<h1><p><a name="Using_The_API"></a></p>
Using The API</h1>
-<p>Nodejitsu provides a web API for users who want to interact with the Nodejitsu platform programatically. This API is built to be RESTful and communicates via JSON.</p>
+<p>Nodejitsu provides a web API for users who want to interact with the Nodejitsu platform programatically. This API is built to be <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer">RESTful</a> and communicates via <a href="http://en.wikipedia.org/wiki/JSON">JSON</a>.</p>
<ul>
<li><a href="#Applications" data-bare-link="true">Applications</a></li>
@@ -241,11 +243,13 @@ <h2 id="Authentication">Authentication</h2>
curl --user Marak:password http://nodejitsu.com/apps/marak
</code></pre>
+<p>TODO: add example of what raw outgoing http request should look like</p>
+
<p><a name="Applications"></a></p>
<h2 id="Applications">Applications</h2>
-<p>Applications are the core of the Nodejitsu API. Each application represents a set Node.js code plus a package.json which contains meta-data about the application such as it's dependencies, database connections, configuration settings, authors, etc. For more information about the package.json format see: LINKTO: package.json docs</p>
+<p>Applications are the core of the Nodejitsu API. Each application represents a set of Node.js code plus a package.json which contains meta-data about the application such as it's dependencies, database connections, configuration settings, authors, etc. For more information about the package.json format see: LINKTO: package.json docs</p>
<h4 id="Get-all-applications-for-a-User">Get all applications for a User</h4>
BIN  book.pdf
View
Binary file not shown
2  chapters/Deploying_Applications.md
View
@@ -1,7 +1,7 @@
<a name="Deploying_Applications"></a>
# Deploying Applications
-TODO: add overview
+There are a few options for how you can deploy your Application to Nodejitsu.
- [Deploying from the Samurai web admin](#Samurai)
- [Deploying from Jitsu, The Nodejitsu Command Line Tool](#Jitsu)
8 chapters/Table_Of_Contents.md
View
@@ -5,7 +5,7 @@
- Deploying from the Samurai web admin
- Deploying from Jitsu, The Nodejitsu Command Line Tool
- Deploying from the API
-- [Using the Jitsu Client](Using_The_Jitsu_Client.md)
+- [Using the Jitsu Client](#Using_The_Jitsu_Client)
- [Installation]()
- [Usage]()
- [Using the API](#Using_The_API)
@@ -21,14 +21,14 @@
- [Redis]()
- [MongoDB]()
- Connecting existing Databases
-- [The MarketPlace](The_Marketplace.md)
+- [The MarketPlace](#The_Marketplace)
- Deploying a Marketplace Application
- Getting your Application on the Marketplace
-- [Add-Ons](Add_Ons.md)
+- [Add-Ons](#Add_Ons)
- MailChimp
- Cloud9
- Adding your service as an add-on
-- [Nodejitsu's Open-source Projects](Open_source_Projects.md)
+- [Nodejitsu's Open-source Projects](#Open_source_Projects)
- Why open-source?
- Where to find
- How to contribute
8 chapters/Using_The_API.md
View
@@ -1,7 +1,7 @@
<a name="Using_The_API"></a>
# Using The API
-Nodejitsu provides a web API for users who want to interact with the Nodejitsu platform programatically. This API is built to be RESTful and communicates via JSON.
+Nodejitsu provides a web API for users who want to interact with the Nodejitsu platform programatically. This API is built to be [RESTful](http://en.wikipedia.org/wiki/Representational_State_Transfer) and communicates via [JSON](http://en.wikipedia.org/wiki/JSON).
- [Applications](#Applications)
- [Snapshots](#Snapshots)
@@ -19,10 +19,12 @@ Most of the calls to the API will require that you authenticate using your Nodej
// get all applications for User "Marak"
curl --user Marak:password http://nodejitsu.com/apps/marak
+TODO: add example of what raw outgoing http request should look like
+
<a name="Applications"></a>
## Applications
-Applications are the core of the Nodejitsu API. Each application represents a set Node.js code plus a package.json which contains meta-data about the application such as it's dependencies, database connections, configuration settings, authors, etc. For more information about the package.json format see: LINKTO: package.json docs
+Applications are the core of the Nodejitsu API. Each application represents a set of Node.js code plus a package.json which contains meta-data about the application such as it's dependencies, database connections, configuration settings, authors, etc. For more information about the package.json format see: LINKTO: package.json docs
#### Get all applications for a User
@@ -138,8 +140,10 @@ All User accounts must be confirmed. When a new User is created, a confirmation
## Logging
#### Get all logs for a user
+
GET /logs/:user-id/
#### Get logs for a specific application
+
GET /logs/:user-id/:app-id
4 chapters/Using_The_Jitsu_Client.md
View
@@ -1,6 +1,8 @@
+<a name="Using_The_Jitsu_Client"></a>
+
# Using The Jitsu Client
-Jitsu is a Command Line Tool (CLI) for interacting with the Nodejitsu platform. It's open-source and easy to use. We've designed Jitsu to be suitable for command line beginners, but still be powerful and extensible enough for production usage. If you aren't a fan of the command line, you can still pretty much do everything Jitsu can do through our web interface, Samurai.
+[Jitsu](http://github.com/nodejitsu/jitsu) is a [Command Line Tool (CLI)](http://en.wikipedia.org/wiki/Command-line_interface) for interacting with the Nodejitsu platform. It's open-source and easy to use. We've designed Jitsu to be suitable for command line beginners, but still be powerful and extensible enough for production usage. If you aren't a fan of the command line or don't have terminal access, you can still do everything Jitsu can do through our web admin, [Samurai](#Samurai).
- [Installation]()
- [Usage]()
15 pages/index.html
View
@@ -1,15 +0,0 @@
-<div class='mp'>
-<h1>The Nodejitsu Handbook</h1>
-<p><em>A gentle introduction to the art of Nodejitsu</em></p>
-
-<p>Welcome to the Nodejitsu handbook. This document will help familiarize you with Nodejitsu while also providing detailed information about specific platform features. This is a living document which you can submit patches to @ <a href="http://github.com/nodejitsu/handbook" data-bare-link="true">http://github.com/nodejitsu/handbook</a>.</p>
-
-<h2 id="What-Is-Nodejitsu-">What Is Nodejitsu?</h2>
-
-<p><a href="http://nodejitsu.com/">Nodejitsu</a> is a Platform as A Service for Node.js applications. Nodejitsu allows you to seamlessly deploy your Node.js applications into the cloud with a myriad of additional features. Nodejitsu's platform provides a robust suite of functionality to assist in the development, management, and deployment of Node.js applications.</p>
-
-<h2 id="How-Can-I-Get-Started-">How Can I Get Started?</h2>
-
-<p>So you wish to learn the ways of Nodejitsu? Excellent! Reading this sentence is the first step! Below, you will find the Table Of Contents which provides an overview of the systems which comprise Nodejitsu. We suggest starting at <a href="#Deploying_Applications" data-bare-link="true">Deploying Applications</a>. You can also always visit our website at <a href="http://nodejitsu.com" data-bare-link="true">http://nodejitsu.com</a>. Good Luck!</p>
-
-</div>
Please sign in to comment.
Something went wrong with that request. Please try again.