Permalink
Browse files

Updates to docs, updates to makefile

  • Loading branch information...
1 parent fabb1c5 commit 1470fb23d26f4fda894f146311769f78754a3665 @Marak Marak committed Mar 14, 2011
View
5 Makefile
@@ -21,7 +21,7 @@ MD = pages/index.md \
HTML = $(MD:.md=.html)
-all: book.html book.pdf book.mobi book.epub
+all: book.html book.pdf clear
regenerate: clean all
git commit -a -m 'Regenerated book' && echo done
@@ -60,4 +60,7 @@ clean:
rm -f book.*
rm -f chapters/*.html
+clear:
+ rm -f chapters/*.html
+
.PHONY: view clean regenerate
View
21 book.html
@@ -314,19 +314,32 @@ <h4 id="Show-the-contents-of-a-Snapshot">Show the contents of a Snapshot</h4>
<h2 id="Users">Users</h2>
-<h4 id="Signup-a-new-User">Signup a new User</h4>
+<h4 id="Create-a-new-User-Sign-up-for-a-free-Nodejitsu-account">Create a new User / Sign-up for a free Nodejitsu account</h4>
-<pre><code> TODO:
+<p>Email address is the only required field.</p>
+
+<pre><code> POST /users/:user-id
+ {
+ email: "youremail@theinternet.com"
+ }
</code></pre>
<h4 id="Confirm-a-User-account">Confirm a User account</h4>
-<pre><code> TODO:
+<p>All User accounts must be confirmed. When a new User is created, a confirmation email will be sent to the email address associated with that user. In this email address, you will receive an invite code. This code must be sent to the API to confirm the account.</p>
+
+<pre><code>POST /users/:user-id
+{
+ inviteCode: "SecretCode"
+}
</code></pre>
<h4 id="Update-User">Update User</h4>
-<pre><code> TODO:
+<pre><code>PUT /users/:user-id
+{
+ password: "new_password"
+}
</code></pre>
<p><a name="Databases"></a></p>
View
BIN book.pdf
Binary file not shown.
View
21 chapters/Add_Ons.html
@@ -1,21 +0,0 @@
-<div class='mp'>
-<h1>Add-Ons</h1>
-<p>TODO: add section</p>
-
-<ul>
-<li>MailChimp</li>
-<li>Add-Ons</li>
-</ul>
-
-
-<h2 id="Deploying-a-Marketplace-Application">Deploying a Marketplace Application</h2>
-
-<pre><code>TODO: add section
-</code></pre>
-
-<h2 id="Getting-your-Application-on-the-Marketplace">Getting your Application on the Marketplace</h2>
-
-<pre><code>TODO: add section
-</code></pre>
-
-</div>
View
39 chapters/Deploying_Applications.html
@@ -1,39 +0,0 @@
-<div class='mp'>
-<h1><p><a name="Deploying_Applications"></a></p>
-
-Deploying Applications</h1>
-<p>TODO: add overview</p>
-
-<ul>
-<li><a href="#Samurai" data-bare-link="true">Deploying from the Samurai web admin</a></li>
-<li><a href="#Jitsu" data-bare-link="true">Deploying from Jitsu, The Nodejitsu Command Line Tool</a></li>
-<li><a href="#API" data-bare-link="true">Deploying from the API</a></li>
-</ul>
-
-
-<p><a name="Samurai"></a></p>
-
-<h2 id="Deploying-from-the-Samurai-web-admin">Deploying from the Samurai web admin</h2>
-
-<p>The Samurai web admin is an easy to use web-site where you can manage and deploy your node.js applications. Simply visit www.nodejitsu.com and sign-in. You'll be taken directly to the Samurai web admin interface.</p>
-
-<p><a name="Jitsu"></a></p>
-
-<h2 id="Deploying-from-Jitsu-The-Nodejitsu-Command-Line-Tool">Deploying from Jitsu, The Nodejitsu Command Line Tool</h2>
-
-<p>If you prefer CLI ( Command Line Interface ) tools over web-sites you can download Jitsu, The Nodejitsu CLI tool. Jitsu is friendly to non-technical users, but it does cover our entire <a href="API" data-bare-link="true">API</a> and it's fully open-source for the more advanced node.js user.</p>
-
-<h3 id="Additional-Jitsu-resources">Additional Jitsu resources</h3>
-
-<p><a name="API"></a></p>
-
-<h2 id="Deploying-from-the-API">Deploying from the API</h2>
-
-<p>If you are an advanced user, you might want to automate your deployment using scripts instead of manually deploying your application using Samurai or Jitsu. Nodejitsu provides a high-level JSON API which will allow you to deploy applications, as well as many other features.</p>
-
-<pre><code> // curl code for deploying a new app
-</code></pre>
-
-<p>You can see a detailed specification of the API here: LINKTO: api docs</p>
-
-</div>
View
28 chapters/Open_Source_Projects.html
@@ -1,28 +0,0 @@
-<div class='mp'>
-<h1>Open-source Projects</h1>
-<p>TODO: add section</p>
-
-<ul>
-<li>Why open-source?</li>
-<li>Where to find</li>
-<li>How to contribute</li>
-</ul>
-
-
-<h2 id="Why-open-source">Why open-source</h2>
-
-<p>A lot of Nodejitsu's technology stack is released as open-source software. We choose to do this for many reasons. Aside from being able to give back to the very awesome Node.js community, releasing pieces of our stack as open-source allows other developers and users to review and improve our software. We've already received invaluable contributions to our platform from developers who would have never seen our code if we had not open-sourced it.</p>
-
-<p>Releasing as open-source increases the quality of our software.</p>
-
-<h2 id="Where-to-find">Where to find</h2>
-
-<p>Nodejitsu hosts it's open-source projects on <a href="http://github.com">Github.com</a>. Github is website for sharing and collobrating on source code. You can get source code without creating an account, and if you want to create an account it's free. You'll need a <a href="http://gitscm.org/">Git</a> client if you wish to check out any of our code repositories.</p>
-
-<p>You can visit our open-source project directory at: <a href="http://github.com/nodejitsu" data-bare-link="true">http://github.com/nodejitsu</a></p>
-
-<h2 id="How-to-contribute">How to contribute</h2>
-
-<p>Anyone can contribute to any Nodejitsu open-source projects at anytime. <a href="http://github.com/nodejitsu">Github</a> has the facilities for managing patches, issues, code comments, version control, etc. If you aren't ready to submit code or have questions you can create a Github issue or even just send an email to the Node.js mailing list. We'll make sure one our Ninja's gets back to you soon.</p>
-
-</div>
View
45 chapters/Setting_Up_Databases.html
@@ -1,45 +0,0 @@
-<div class='mp'>
-<h1>Setting Up A Database For Your Application</h1>
-<p>Nodejitsu has several Node.js friendly databases ready to be used by your application. 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 with our partners such as Redis2Go, CouchOne, and MongoHQ.</p>
-
-<ul>
-<li>Creating new Databases
-
-<ul>
-<li><a href="">CouchDB</a></li>
-<li><a href="">Redis</a></li>
-<li><a href="">MongoDB</a></li>
-</ul>
-</li>
-<li>Connecting existing Databases</li>
-</ul>
-
-
-<h2 id="Creating-new-Databases">Creating new Databases</h2>
-
-<p>If you require database hosting, you can create a new database instance of any of our supported databases using Samaruai, Jitsu, or our API.</p>
-
-<h3 id="CouchDB">CouchDB</h3>
-
-<pre><code>TODO: add section
-</code></pre>
-
-<h3 id="Redis">Redis</h3>
-
-<pre><code>TODO: add section
-</code></pre>
-
-<h3 id="MongoDB">MongoDB</h3>
-
-<pre><code>TODO: add section
-</code></pre>
-
-<h2 id="Existing-Databases">Existing Databases</h2>
-
-<p>If you already have an externally hosted Database, Nodejitsu is capable of connecting to it. We've got Database hosting if you need it, but we fully support externally hosted Databases.</p>
-
-<h2 id="Connecting-Applications-to-Databases">Connecting Applications to Databases</h2>
-
-<p>If you want to connect a Database to your Node.js application, Nodejitsu provides you with sample code for each Database type as well as the ability to specify database connection strings in your application's package.json</p>
-
-</div>
View
70 chapters/Table_Of_Contents.html
@@ -1,70 +0,0 @@
-<div class='mp'>
-<h1>Table of Contents</h1>
-<ul>
-<li><a href="#Deploying_Applications" data-bare-link="true">Deploying Applications</a>
-
-<ul>
-<li>Deploying from the Samurai web admin</li>
-<li>Deploying from Jitsu, The Nodejitsu Command Line Tool</li>
-<li>Deploying from the API</li>
-</ul>
-</li>
-<li><a href="Using_The_Jitsu_Client.md">Using the Jitsu Client</a>
-
-<ul>
-<li><a href="">Installation</a></li>
-<li><a href="">Usage</a></li>
-</ul>
-</li>
-<li><a href="#Using_The_API" data-bare-link="true">Using the API</a>
-
-<ul>
-<li><a href="#Applications" data-bare-link="true">Applications</a></li>
-<li><a href="#Snapshots" data-bare-link="true">Snapshots</a></li>
-<li><a href="#User" data-bare-link="true">Users</a></li>
-<li><a href="#Database" data-bare-link="true">Databases</a></li>
-<li><a href="#Marketplace" data-bare-link="true">Marketplace</a></li>
-<li><a href="#Logging" data-bare-link="true">Logging</a></li>
-</ul>
-</li>
-<li><a href="Setting_Up_Databases.md">Databases</a>
-
-<ul>
-<li>Creating new Databases
-
-<ul>
-<li><a href="">CouchDB</a></li>
-<li><a href="">Redis</a></li>
-<li><a href="">MongoDB</a></li>
-</ul>
-</li>
-<li>Connecting existing Databases</li>
-</ul>
-</li>
-<li><a href="The_Marketplace.md">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>
-
-<ul>
-<li>MailChimp</li>
-<li>Cloud9</li>
-<li>Adding your service as an add-on</li>
-</ul>
-</li>
-<li><a href="Open_source_Projects.md">Nodejitsu's Open-source Projects</a>
-
-<ul>
-<li>Why open-source?</li>
-<li>Where to find</li>
-<li>How to contribute</li>
-</ul>
-</li>
-</ul>
-
-
-</div>
View
20 chapters/The_Marketplace.html
@@ -1,20 +0,0 @@
-<div class='mp'>
-<h1>The Marketplace</h1>
-<p>The Marketplace is an online store where you can browse ready to go Node.js Applications and clone and deploy your own copy in seconds. The Marketplace is 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.</p>
-
-<ul>
-<li>Deploying a Marketplace Application</li>
-<li>Getting your Application on the Marketplace</li>
-</ul>
-
-
-<h2 id="Deploying-a-Marketplace-Application">Deploying a Marketplace Application</h2>
-
-<p>You can deploy a ready to go application from the Marketplace is seconds and begin customize it for your needs immediately. Marketplace Applications can be configured through Samurai, Jitsu, or the API.</p>
-
-<h2 id="Getting-your-Application-on-the-Marketplace">Getting your Application on the Marketplace</h2>
-
-<pre><code>TODO: add section
-</code></pre>
-
-</div>
View
166 chapters/Using_The_API.html
@@ -1,166 +0,0 @@
-<div class='mp'>
-<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>
-
-<ul>
-<li><a href="#Applications" data-bare-link="true">Applications</a></li>
-<li><a href="#Snapshots" data-bare-link="true">Snapshots</a></li>
-<li><a href="#User" data-bare-link="true">Users</a></li>
-<li><a href="#Database" data-bare-link="true">Databases</a></li>
-<li><a href="#Marketplace" data-bare-link="true">Marketplace</a></li>
-<li><a href="#Logging" data-bare-link="true">Logging</a></li>
-</ul>
-
-
-<h2 id="Authentication">Authentication</h2>
-
-<p>Most of the calls to the API will require that you authenticate using your Nodejitsu account. If you do not have an account it is possible to create one using the User API, the Jitsu CLI, or just by visiting <a href="http://nodejitsu.com" data-bare-link="true">http://nodejitsu.com</a>. Currently, we support <a href="http://en.wikipedia.org/wiki/Basic_access_authentication">Basic Authentication</a>. If you haven't used Basic Auth before don't fret, it's easy!</p>
-
-<p><strong>Here is an example using the command line utility, <a href="http://curl.haxx.se/">Curl</a>.</strong></p>
-
-<pre><code> // get all applications for User "Marak"
- curl --user Marak:password http://nodejitsu.com/apps/marak
-</code></pre>
-
-<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>
-
-<h4 id="Get-all-applications-for-a-User">Get all applications for a User</h4>
-
-<pre><code> GET /apps/:user-id
-</code></pre>
-
-<h4 id="Create-a-new-Application">Create a new Application</h4>
-
-<pre><code> POST /apps/:user-id
- { package.json }
-</code></pre>
-
-<h4 id="Start-an-Application">Start an Application</h4>
-
-<pre><code> POST /apps/:user-id/:app-id/restart
-</code></pre>
-
-<h4 id="Stop-an-Application">Stop an Application</h4>
-
-<pre><code> POST /apps/:user-id/:app-id/start
-</code></pre>
-
-<h4 id="Restart-an-Application">Restart an Application</h4>
-
-<pre><code> POST /apps/:user-id/:app-id/stop
-</code></pre>
-
-<h4 id="Update-an-Application">Update an Application</h4>
-
-<pre><code> PUT /apps/:user-id
- { package.json }
-</code></pre>
-
-<h4 id="Delete-an-Application">Delete an Application</h4>
-
-<pre><code> DELETE /apps/:user-id/:app-id/remove
-</code></pre>
-
-<p><a name="Snapshots"></a></p>
-
-<h2 id="Snapshots">Snapshots</h2>
-
-<p>Snapshots are an easy way to capture the current state of your application. Once a Snapshot of your application is created you can roll back and activate that Snapshot at any time.</p>
-
-<h4 id="Make-an-existing-snapshot-the-active-app">Make an existing snapshot the active app</h4>
-
-<pre><code>PUT /apps/:user-id/:app-id/snapshots/:id/active
-</code></pre>
-
-<h4 id="Activate-Deploy-a-snapshot">Activate / Deploy a snapshot</h4>
-
-<pre><code>POST /apps/:user-id/:snapshots/:id
-</code></pre>
-
-<h4 id="Show-a-catalog-of-all-Snapshot-for-an-Application">Show a catalog of all Snapshot for an Application</h4>
-
-<pre><code>GET /apps/:user-id/:app-id/snapshots
-</code></pre>
-
-<h4 id="Show-the-contents-of-a-Snapshot">Show the contents of a Snapshot</h4>
-
-<pre><code>GET /apps/:user-id/:app-id/snapshots/:id
-</code></pre>
-
-<p><a name="Users"></a></p>
-
-<h2 id="Users">Users</h2>
-
-<h4 id="Signup-a-new-User">Signup a new User</h4>
-
-<pre><code> TODO:
-</code></pre>
-
-<h4 id="Confirm-a-User-account">Confirm a User account</h4>
-
-<pre><code> TODO:
-</code></pre>
-
-<h4 id="Update-User">Update User</h4>
-
-<pre><code> TODO:
-</code></pre>
-
-<p><a name="Databases"></a></p>
-
-<h2 id="Databases">Databases</h2>
-
-<h4 id="Create-a-new-Database">Create a new Database</h4>
-
-<pre><code> POST /databases/:user-id/:id
-
- {
- type: "Couch || Redis || Mongo"
- }
-</code></pre>
-
-<h4 id="Get-information-about-a-Database">Get information about a Database</h4>
-
-<pre><code>GET /databases/:user-id/:id
-</code></pre>
-
-<h4 id="Delete-a-Database">Delete a Database</h4>
-
-<pre><code>DELETE /databases/:user-id/:id
-</code></pre>
-
-<p><a name="Marketplace"></a></p>
-
-<h2 id="Marketplace">Marketplace</h2>
-
-<h4 id="Get-all-Marketplace-Applications">Get all Marketplace Applications</h4>
-
-<pre><code>GET /marketplace
-</code></pre>
-
-<h4 id="Get-a-specific-Marketplace-Application">Get a specific Marketplace Application</h4>
-
-<pre><code>GET /databases/:user-id/:id
-</code></pre>
-
-<p><a name="Logging"></a></p>
-
-<h2 id="Logging">Logging</h2>
-
-<h4 id="Get-all-logs-for-a-user">Get all logs for a user</h4>
-
-<pre><code> GET /logs/:user-id/
-</code></pre>
-
-<h4 id="Get-logs-for-a-specific-application">Get logs for a specific application</h4>
-
-<pre><code> GET /logs/:user-id/:app-id
-</code></pre>
-
-</div>
View
23 chapters/Using_The_API.md
@@ -76,18 +76,31 @@ Snapshots are an easy way to capture the current state of your application. Once
## Users
-#### Signup a new User
+#### Create a new User / Sign-up for a free Nodejitsu account
- TODO:
+Email address is the only required field.
+
+ POST /users/:user-id
+ {
+ email: "youremail@theinternet.com"
+ }
#### Confirm a User account
- TODO:
+All User accounts must be confirmed. When a new User is created, a confirmation email will be sent to the email address associated with that user. In this email address, you will receive an invite code. This code must be sent to the API to confirm the account.
-#### Update User
+ POST /users/:user-id
+ {
+ inviteCode: "SecretCode"
+ }
- TODO:
+#### Update User
+ PUT /users/:user-id
+ {
+ password: "new_password"
+ }
+
<a name="Databases"></a>
## Databases
View
21 chapters/Using_The_Jitsu_Client.html
@@ -1,21 +0,0 @@
-<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>
-
-<ul>
-<li><a href="">Installation</a></li>
-<li><a href="">Usage</a></li>
-</ul>
-
-
-<h2 id="Installation">Installation</h2>
-
-<pre><code> TODO: add section
-</code></pre>
-
-<h2 id="Usage">Usage</h2>
-
-<pre><code> TODO: add section
-</code></pre>
-
-</div>

0 comments on commit 1470fb2

Please sign in to comment.