Permalink
Browse files

Added contrib docs

  • Loading branch information...
1 parent 893aa80 commit f0ba57ba23e71f774a2dcda3c6992298d69bf624 @tj tj committed Jul 14, 2010
Showing with 403 additions and 16 deletions.
  1. +5 −0 .pomo
  2. +1 −0 Makefile
  3. +13 −11 docs/api.html
  4. +96 −0 docs/contrib.1
  5. +220 −0 docs/contrib.html
  6. +29 −0 docs/contrib.md
  7. +2 −1 docs/executable.html
  8. +2 −1 docs/guide.html
  9. +2 −1 docs/index.html
  10. +2 −1 docs/layout/head.html
  11. +16 −0 docs/migrate.1
  12. +15 −1 docs/migrate.html
View
5 .pomo
@@ -39,3 +39,8 @@
description:
length: 25
name: contributing section
+- !ruby/object:Pomo::Task
+ complete: false
+ description:
+ length: 25
+ name: custom 404 / 500 etc
View
1 Makefile
@@ -4,6 +4,7 @@ LIB_PREFIX = ~/.node_libraries
DOCS = docs/index.md \
docs/executable.md \
+ docs/contrib.md \
docs/guide.md \
docs/migrate.md
View
24 docs/api.html
@@ -475,7 +475,7 @@
<li><p><strong>return</strong>: <em>String</em></p></li>
<li><p><strong>api</strong>: <em>public</em></p></li>
</ul>
-
+���:
</td>
<td class="code">
<pre><code><span class="variable">http</span>.<span class="class">IncomingMessage</span>.<span class="variable">prototype</span>.<span class="variable">param</span> = <span class="keyword">function</span>(<span class="variable">name</span>){
@@ -622,7 +622,7 @@
</tr>
<tr class="code">
<td class="docs">
-<p>Inherit from <code>connect.Server</code>.</p>
+<p>Inherit from <code>connect.Server</code>.</p>
</td>
<td class="code">
<pre><code><span class="variable">sys</span>.<span class="variable">inherits</span>(<span class="class">Server</span>, <span class="variable">connect</span>.<span class="class">Server</span>);</code></pre>
@@ -743,7 +743,7 @@
<li><p><strong>return</strong>: <em>Server</em> for chaining</p></li>
<li><p><strong>api</strong>: <em>public</em></p></li>
</ul>
-VQ
+
</td>
<td class="code">
<pre><code><span class="class">Server</span>.<span class="variable">prototype</span>.<span class="variable">enable</span> = <span class="keyword">function</span>(<span class="variable">setting</span>){
@@ -762,7 +762,7 @@
<li><p><strong>return</strong>: <em>Server</em> for chaining</p></li>
<li><p><strong>api</strong>: <em>public</em></p></li>
</ul>
-P
+
</td>
<td class="code">
<pre><code><span class="class">Server</span>.<span class="variable">prototype</span>.<span class="variable">disable</span> = <span class="keyword">function</span>(<span class="variable">setting</span>){
@@ -781,7 +781,7 @@
<li><p><strong>return</strong>: <em>Server</em> for chaining</p></li>
<li><p><strong>api</strong>: <em>public</em></p></li>
</ul>
-P
+
</td>
<td class="code">
<pre><code><span class="class">Server</span>.<span class="variable">prototype</span>.<span class="variable">configure</span> = <span class="keyword">function</span>(<span class="variable">env</span>, <span class="variable">fn</span>){
@@ -818,7 +818,7 @@
<li><p><strong>return</strong>: <em>String</em></p></li>
<li><p><strong>api</strong>: <em>public</em></p></li>
</ul>
-
+
</td>
<td class="code">
<pre><code><span class="variable">exports</span>.<span class="variable">miniMarkdown</span> = <span class="keyword">function</span>(<span class="variable">str</span>){
@@ -886,7 +886,7 @@
<ul>
<li><strong>type</strong>: <em>Object</em></li>
</ul>
-
+
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">viewCache</span> = {};</code></pre>
@@ -899,7 +899,7 @@
<ul>
<li><strong>api</strong>: <em>public</em></li>
</ul>
-
+
</td>
<td class="code">
<pre><code><span class="variable">exports</span>.<span class="variable">clearCache</span> = <span class="keyword">function</span>(){
@@ -914,7 +914,7 @@
<ul>
<li><strong>type</strong>: <em>Object</em></li>
</ul>
-
+
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">helpers</span> = <span class="variable">exports</span>.<span class="variable">helpers</span> = {};</code></pre>
@@ -948,7 +948,7 @@
<li><p><strong>return</strong>: <em>String</em></p></li>
<li><p><strong>api</strong>: <em>public</em></p></li>
</ul>
-VQ
+
</td>
<td class="code">
<pre><code><span class="variable">http</span>.<span class="class">ServerResponse</span>.<span class="variable">prototype</span>.<span class="variable">partial</span> = <span class="keyword">function</span>(<span class="variable">view</span>, <span class="variable">options</span>, <span class="variable">ext</span>){
@@ -1014,7 +1014,9 @@
<li><p><strong>param</strong>: <em>Function</em> fn</p></li>
<li><p><strong>api</strong>: <em>public</em></p></li>
</ul>
-�
+: <em>public</em></p></li>
+</ul>
+���:
</td>
<td class="code">
<pre><code><span class="variable">http</span>.<span class="class">ServerResponse</span>.<span class="variable">prototype</span>.<span class="variable">render</span> = <span class="keyword">function</span>(<span class="variable">view</span>, <span class="variable">options</span>, <span class="variable">fn</span>){
View
96 docs/contrib.1
@@ -0,0 +1,96 @@
+.\" generated with Ronn/v0.6.6
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "CONTRIB" "" "July 2010" "" ""
+.
+.SS "Development Dependencies"
+Express development dependencies are stored within the \fI\./support\fR directory\. To update them execute:
+.
+.IP "" 4
+.
+.nf
+
+$ git submodule update \-\-init
+.
+.fi
+.
+.IP "" 0
+.
+.SS "Running Tests"
+Express uses the Expresso \fIhttp://github\.com/visionmedia/expresso\fR TDD framework to write and run elegant test suites extremely fast\. To run all test suites simply execute:
+.
+.IP "" 4
+.
+.nf
+
+$ make test
+.
+.fi
+.
+.IP "" 0
+.
+.P
+To target specific suites we may specify the files via:
+.
+.IP "" 4
+.
+.nf
+
+$ make test TESTS=test/view\.test\.js
+.
+.fi
+.
+.IP "" 0
+.
+.SS "Contributions"
+To accept a contribution, you should follow these guidelines:
+.
+.IP "\(bu" 4
+All tests \fImust\fR pass
+.
+.IP "\(bu" 4
+Your alterations or additions \fImust\fR include tests
+.
+.IP "\(bu" 4
+Your commit(s) should be \fIfocused\fR, do not commit once for several changes
+.
+.IP "\(bu" 4
+Do \fInot\fR alter release information such as the \fIversion\fR, or \fIHistory\.md\fR
+.
+.IP "\(bu" 4
+Indents are \fI4\fR spaces\.
+.
+.IP "" 0
+.
+.SS "Style Guide"
+good:
+.
+.IP "" 4
+.
+.nf
+
+if (foo) {
+ bar();
+ baz();
+}
+.
+.fi
+.
+.IP "" 0
+.
+.P
+bad:
+.
+.IP "" 4
+.
+.nf
+
+if(foo) {
+ bar()
+ baz()
+}
+.
+.fi
+.
+.IP "" 0
+
View
220 docs/contrib.html
@@ -0,0 +1,220 @@
+<html>
+ <head>
+ <title>Express - node web framework</title>
+ <style>
+ #header {
+ position: absolute;
+ top: 10px;
+ left: 0;
+ padding: 12px 0;
+ text-indent: 40px;
+ width: 100%;
+ border-top: 1px solid rgba(0,0,0,0.7);
+ border-bottom: 1px solid rgba(0,0,0,0.7);
+ background: rgba(255,255,255,0.1) url(http://www.sencha.com/favicon.ico) no-repeat 15px 50%;
+ text-align: left;
+ color: #fff;
+ }
+ #tagline {
+ margin-left: 75px;
+ margin-bottom: 30px;
+ color: rgba(255,255,255,0.7); }
+ html {
+ background: #1c1c1c url(images/bg.tile.jpg); }
+
+ body {
+ margin: 0;
+ padding-bottom: 30px;
+ font: 14px/1.4 "Helvetica Neue", "Lucida Grande", "Arial";
+ font-size: 14px;
+ line-height: 1.5;
+ -webkit-text-stroke: 1px rgba(0, 0, 0, 0.1);
+ -moz-text-stroke: 1px rgba(0, 0, 0, 0.1);
+ background: url(images/bg.jpg) 50% 0 no-repeat;
+ color: #8b8b8b; }
+
+ * {
+ outline: none; }
+
+ em {
+ color: white; }
+
+ a img {
+ border: none !important; }
+
+ a {
+ font-weight: bold;
+ color: white;
+ -webkit-transition-property: opacity, -webkit-transform, color, background-color, padding, -webkit-box-shadow;
+ -webkit-transition-duration: 0.15s;
+ -webkit-transition-timing-function: ease-out; }
+ a:hover {
+ opacity: 0.8; }
+
+ h1, h2, h3 {
+ margin: 45px 0 0 0;
+ color: white;
+ text-shadow: 1px 2px 2px rgba(0,0,0,0.6); }
+
+ h3 {
+ font-size: 18px; }
+
+ pre {
+ margin: 20px 10px;
+ padding: 25px 20px;
+ background: rgba(0,0,0,0.5);
+ border: 1px solid #323232;
+ -webkit-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
+ -moz-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
+ -webkit-border-radius: 5px;
+ -moz-border-radius: 5px; }
+
+ code {
+ font-family: "Helvetica Neue", "Lucida Grande", "Arial"; }
+
+ ul {
+ margin: 15px 0;
+ padding: 0 0 0 35px; }
+ ul li {
+ margin: 0;
+ padding: 2px 0;
+ list-style: square; }
+
+ .sect {
+ margin-left: 40px; }
+
+ #logo {
+ display: block;
+ margin-left: 30%;
+ margin-bottom: 30px;
+ width: 194px;
+ height: 51px;
+ background: url(images/logo.png) 0 0 no-repeat;
+ text-indent: -99999px; }
+ #logo:hover {
+ opacity: 0.7; }
+ #logo:active {
+ opacity: 0.3; }
+
+ #ribbon {
+ position: fixed;
+ top: 0;
+ right: 0;
+ z-index: 2; }
+
+ #wrapper {
+ width: 100%;
+ min-height: 800px;
+ background: url(images/top.png) 0 0 repeat-x; }
+
+ #container {
+ margin: 0 auto;
+ padding-top: 110px;
+ width: 550px; }
+
+ #menu {
+ margin-left: 65px;
+ padding: 0;
+ padding-bottom: 30px; }
+ #menu li {
+ display: inline;
+ list-style: none; }
+ #menu li a {
+ display: block;
+ float: left;
+ margin: 0 2px;
+ padding: 3px 15px;
+ background: rgba(0,0,0,0.2);
+ -webkit-border-radius: 8px;
+ -moz-border-radius: 8px;
+ -webkit-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
+ -moz-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
+ -webkit-transition-property: opacity, -webkit-transform, color, background-color, -webkit-box-shadow;
+ -webkit-transition-duration: 0.15s;
+ -webkit-transition-timing-function: ease-out; }
+ #menu li a:hover,
+ #menu li a.active {
+ background: rgba(0,0,0,0.5); }
+ #menu li a:active {
+ background: rgba(0,0,0,0.1);
+ -webkit-box-shadow: 1px 1px 1px rgba(0,0,0,0.4);
+ -moz-box-shadow: 1px 1px 1px rgba(0,0,0,0.4); }
+ </style>
+ </head>
+ <body>
+ <a href='http://github.com/visionmedia/express'>
+ <img alt='Fork me on GitHub' id='ribbon' src='http://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png' />
+ </a>
+ <div id="header"><strong>Sencha</strong> labs</div>
+ <div id="wrapper">
+ <div id="container">
+ <a href='http://github.com/visionmedia/express' id='logo'>Express</a>
+ <p id="tagline">
+ High performance, high class web development for
+ <a href="http://nodejs.org">Node.js</a>
+ </p>
+ <ul id="menu">
+ <li><a href="index.html">Home</a></li>
+ <li><a href="guide.html">Guide</a></li>
+ <li><a href="contrib.html">Contributing</a></li>
+ <li><a href="migrate.html">1.x Migration</a></li>
+ </ul>
+<div class='mp'>
+<h3 id="Development-Dependencies">Development Dependencies</h3>
+
+<p>Express development dependencies are stored within the <em>./support</em> directory. To
+update them execute:</p>
+
+<pre><code>$ git submodule update --init
+</code></pre>
+
+<h3 id="Running-Tests">Running Tests</h3>
+
+<p>Express uses the <a href="http://github.com/visionmedia/expresso">Expresso</a> TDD
+framework to write and run elegant test suites extremely fast. To run all test suites
+simply execute:</p>
+
+<pre><code>$ make test
+</code></pre>
+
+<p>To target specific suites we may specify the files via:</p>
+
+<pre><code>$ make test TESTS=test/view.test.js
+</code></pre>
+
+<h3 id="Contributions">Contributions</h3>
+
+<p>To accept a contribution, you should follow these guidelines:</p>
+
+<ul>
+<li>All tests <em>must</em> pass</li>
+<li>Your alterations or additions <em>must</em> include tests</li>
+<li>Your commit(s) should be <em>focused</em>, do not commit once for several changes</li>
+<li>Do <em>not</em> alter release information such as the <em>version</em>, or <em>History.md</em></li>
+<li>Indents are <em>4</em> spaces.</li>
+</ul>
+
+
+<h3 id="Style-Guide">Style Guide</h3>
+
+<p>good:</p>
+
+<pre><code>if (foo) {
+ bar();
+ baz();
+}
+</code></pre>
+
+<p>bad:</p>
+
+<pre><code>if(foo) {
+ bar()
+ baz()
+}
+</code></pre>
+
+</div>
+ </div>
+ </div>
+ </body>
+</html>
View
29 docs/contrib.md
@@ -0,0 +1,29 @@
+
+### Development Dependencies
+
+Express development dependencies are stored within the _./support_ directory. To
+update them execute:
+
+ $ git submodule update --init
+
+### Running Tests
+
+Express uses the [Expresso](http://github.com/visionmedia/expresso) TDD
+framework to write and run elegant test suites extremely fast. To run all test suites
+simply execute:
+
+ $ make test
+
+To target specific suites we may specify the files via:
+
+ $ make test TESTS=test/view.test.js
+
+### Contributions
+
+To accept a contribution, you should follow these guidelines:
+
+ * All tests _must_ pass
+ * Your alterations or additions _must_ include tests
+ * Your commit(s) should be _focused_, do not commit once for several changes
+ * Do _not_ alter release information such as the _version_, or _History.md_
+ * Indents are _4_ spaces.
View
3 docs/executable.html
@@ -113,7 +113,7 @@
width: 550px; }
#menu {
- margin-left: 130px;
+ margin-left: 65px;
padding: 0;
padding-bottom: 30px; }
#menu li {
@@ -156,6 +156,7 @@
<ul id="menu">
<li><a href="index.html">Home</a></li>
<li><a href="guide.html">Guide</a></li>
+ <li><a href="contrib.html">Contributing</a></li>
<li><a href="migrate.html">1.x Migration</a></li>
</ul>
<div class='mp'>
View
3 docs/guide.html
@@ -113,7 +113,7 @@
width: 550px; }
#menu {
- margin-left: 130px;
+ margin-left: 65px;
padding: 0;
padding-bottom: 30px; }
#menu li {
@@ -156,6 +156,7 @@
<ul id="menu">
<li><a href="index.html">Home</a></li>
<li><a href="guide.html">Guide</a></li>
+ <li><a href="contrib.html">Contributing</a></li>
<li><a href="migrate.html">1.x Migration</a></li>
</ul>
<div class='mp'>
View
3 docs/index.html
@@ -113,7 +113,7 @@
width: 550px; }
#menu {
- margin-left: 130px;
+ margin-left: 65px;
padding: 0;
padding-bottom: 30px; }
#menu li {
@@ -156,6 +156,7 @@
<ul id="menu">
<li><a href="index.html">Home</a></li>
<li><a href="guide.html">Guide</a></li>
+ <li><a href="contrib.html">Contributing</a></li>
<li><a href="migrate.html">1.x Migration</a></li>
</ul>
<div class='mp'>
View
3 docs/layout/head.html
@@ -113,7 +113,7 @@
width: 550px; }
#menu {
- margin-left: 130px;
+ margin-left: 65px;
padding: 0;
padding-bottom: 30px; }
#menu li {
@@ -156,5 +156,6 @@
<ul id="menu">
<li><a href="index.html">Home</a></li>
<li><a href="guide.html">Guide</a></li>
+ <li><a href="contrib.html">Contributing</a></li>
<li><a href="migrate.html">1.x Migration</a></li>
</ul>
View
16 docs/migrate.1
@@ -327,4 +327,20 @@ res\.redirect(\'/somewhere\');
.fi
.
.IP "" 0
+.
+.SS "HTTP Client"
+Previously Express provided a high level http client, this library is no more as it does not belong in Express, however it may be resurrected as a separate module\.
+.
+.SS "Core Extensions"
+Express is no longer dependent on the JavaScript Extensions \fIhttp://github\.com/visionmedia/ext\.js\fR library, so those of you using the methods provided by it such as \fBObject\.merge(a, b)\fR will need to roll your own, or install the module via:
+.
+.IP "" 4
+.
+.nf
+
+$ npm install ext
+.
+.fi
+.
+.IP "" 0
View
16 docs/migrate.html
@@ -113,7 +113,7 @@
width: 550px; }
#menu {
- margin-left: 130px;
+ margin-left: 65px;
padding: 0;
padding-bottom: 30px; }
#menu li {
@@ -156,6 +156,7 @@
<ul id="menu">
<li><a href="index.html">Home</a></li>
<li><a href="guide.html">Guide</a></li>
+ <li><a href="contrib.html">Contributing</a></li>
<li><a href="migrate.html">1.x Migration</a></li>
</ul>
<div class='mp'>
@@ -358,6 +359,19 @@ <h3 id="Redirect">Redirect</h3>
<pre><code>res.redirect('/somewhere');
</code></pre>
+<h3 id="HTTP-Client">HTTP Client</h3>
+
+<p>Previously Express provided a high level http client, this library is no more
+as it does not belong in Express, however it may be resurrected as a separate module.</p>
+
+<h3 id="Core-Extensions">Core Extensions</h3>
+
+<p>Express is no longer dependent on the <a href="http://github.com/visionmedia/ext.js">JavaScript Extensions</a> library, so those of you using the methods provided by it such as <code>Object.merge(a, b)</code> will need to
+roll your own, or install the module via:</p>
+
+<pre><code>$ npm install ext
+</code></pre>
+
</div>
</div>
</div>

0 comments on commit f0ba57b

Please sign in to comment.