Style and other minor updates

cloudfoundry-attic · Jan 25, 2013 · cb538eb · cb538eb
1 parent 2a830a1
commit cb538eb
Show file tree

Hide file tree

Showing 35 changed files with 416 additions and 105 deletions.
diff --git a/.gitignore b/.gitignore
@@ -12,3 +12,7 @@
 
 # Ignore Sass' cache
 /.sass-cache
+
+.idea
+/vendor
+.DS_Store
diff --git a/Gemfile b/Gemfile
@@ -1,4 +1,6 @@
 source :rubygems
 
 gem "middleman", "~>3.0.10"
-gem "redcarpet", "~>2.2.2"
+gem "redcarpet", "~>2.2.2"
+
+gem 'middleman-syntax'
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -56,6 +56,9 @@ GEM
       middleman-more (>= 3.0.1)
       sprockets (~> 2.1, < 2.5)
       sprockets-sass (~> 0.9.0)
+    middleman-syntax (1.0.1)
+      middleman-core (~> 3.0)
+      pygments.rb (~> 0.3)
     multi_json (1.5.0)
     padrino-core (0.10.7)
       activesupport (~> 3.2.0)
@@ -66,6 +69,10 @@ GEM
     padrino-helpers (0.10.7)
       i18n (~> 0.6)
       padrino-core (= 0.10.7)
+    posix-spawn (0.3.6)
+    pygments.rb (0.3.7)
+      posix-spawn (~> 0.3.6)
+      yajl-ruby (~> 1.1.0)
     rack (1.4.4)
     rack-protection (1.3.2)
       rack
@@ -96,10 +103,12 @@ GEM
       multi_json (~> 1.3)
     url_mount (0.2.1)
       rack
+    yajl-ruby (1.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   middleman (~> 3.0.10)
+  middleman-syntax
   redcarpet (~> 2.2.2)
diff --git a/README.md b/README.md
@@ -24,5 +24,5 @@ If you want to contribute on a larger scale, see the [Pivotal Project for CF Doc
 
 **Support**
 
-[suport.cloudfoundry.com](http://suport.cloudfoundry.com)
+[support.cloudfoundry.com](http://support.cloudfoundry.com)
 
diff --git a/config.rb b/config.rb
@@ -81,4 +81,6 @@
 
   # Or use a different image path
   # set :http_path, "/Content/images/"
-end
+end
+
+activate :syntax
diff --git a/source/docs/running/architecture/index.html.md b/source/docs/running/architecture/index.html.md
@@ -0,0 +1,7 @@
+---
+title: Cloud Foundry Architecture
+---
+
+## Cloud Foundry Architecture
+
+Coming soon...
diff --git a/source/docs/running/deploying-cf/components/index.html.md b/source/docs/running/deploying-cf/components/index.html.md
@@ -2,13 +2,13 @@
 title: BOSH Components
 ---
 
-A little text here.
+[Intro text here]
 
-[Director](director.html)
-[Messaging](messaging.html)
-[Workers](workers.html)
-[Health Monitor](health-monitor.html)
-[Stemcell](stemcell.html)
-[Agent](agent.html)
-[Blobstore](blobstore.html)
-[Micro BOSH](micro-bosh.html)
+- [Director](director.html)
+- [Messaging](messaging.html)
+- [Workers](workers.html)
+- [Health Monitor](health-monitor.html)
+- [Stemcell](stemcell.html)
+- [Agent](agent.html)
+- [Blobstore](blobstore.html)
+- [Micro BOSH](micro-bosh.html)
diff --git a/source/docs/running/deploying-cf/ec2/index.html.md b/source/docs/running/deploying-cf/ec2/index.html.md
@@ -2,4 +2,6 @@
 title: Deploying Cloud Foundry on EC2
 ---
 
-instructions...
+## Deploying Cloud Foundry on EC2
+
+Instructions coming soon...
diff --git a/source/docs/running/deploying-cf/index.html.md b/source/docs/running/deploying-cf/index.html.md
@@ -2,11 +2,11 @@
 title: Deploying to the Cloud with BOSH
 ---
 
-An introduction to BOSH here
+[An introduction to BOSH here]
 
-[components](components/index.html)
-[releases](releases/index.html)
-[Deploying to EC2](ec2/index.html)
-[Deploying to OpenStack](openstack/index.html)
-[Deploying to vSphere](vsphere/index.html)
-[Monitoring](monitoring/index.html)
+- [Components](components/index.html)
+- [Releases](releases/index.html)
+- [Deploying to EC2](ec2/index.html)
+- [Deploying to OpenStack](openstack/index.html)
+- [Deploying to vSphere](vsphere/index.html)
+- [Monitoring](/docs/running/monitoring/index.html)
diff --git a/source/docs/running/deploying-cf/openstack/index.html.md b/source/docs/running/deploying-cf/openstack/index.html.md
@@ -2,4 +2,6 @@
 title: Deploying Cloud Foundry on OpenStack
 ---
 
-Instructions...
+## Deploying Cloud Foundry on OpenStack
+
+Instructions coming soon...
diff --git a/source/docs/running/deploying-cf/releases/index.html.md b/source/docs/running/deploying-cf/releases/index.html.md
@@ -2,4 +2,6 @@
 title: Understanding Releases
 ---
 
-Etc...
+## Understanding Releases
+
+Coming soon...
diff --git a/source/docs/running/deploying-cf/vsphere/index.html.md b/source/docs/running/deploying-cf/vsphere/index.html.md
@@ -2,4 +2,6 @@
 title: Deploying Cloud Foundry on vSphere
 ---
 
-Etc...
+## Deploying Cloud Foundry on vSphere
+
+Instructions coming soon...
diff --git a/source/docs/running/index.html.md b/source/docs/running/index.html.md
@@ -0,0 +1,7 @@
+---
+title: Running Apps on Cloud Foundry
+---
+
+## Running Apps on Cloud Foundry
+
+Coming soon...
diff --git a/source/docs/running/monitoring/index.html.md b/source/docs/running/monitoring/index.html.md
@@ -2,4 +2,6 @@
 title: Monitoring
 ---
 
-How to Monitor a Cloud Foundry installation
+##  Monitoring
+
+How to Monitor a Cloud Foundry Installation (coming soon)
diff --git a/source/docs/using/deploying-apps/custom/index.html.md b/source/docs/using/deploying-apps/custom/index.html.md
@@ -2,4 +2,4 @@
 title: Introduction to Custom Buildpacks
 ---
 
-Etc...
+Coming soon...
diff --git a/source/docs/using/deploying-apps/index.html.md b/source/docs/using/deploying-apps/index.html.md
@@ -0,0 +1,7 @@
+---
+title: Deploying Apps
+---
+
+## Deploying Apps
+
+Coming soon...
diff --git a/source/docs/using/deploying-apps/javascript/index.html.md b/source/docs/using/deploying-apps/javascript/index.html.md
@@ -30,16 +30,15 @@ For the purposes of this tutorial we will build a very simple application that m
 
 Open a shell and create a folder for your application in your desired location
 
-~~~console
+<pre class="terminal">
 $ cd ~/Projects
 $ mkdir hello-node
 $ cd hello-node
-~~~
+</pre>
 
 Create a file called "app.js" with the following contents;
 
-~~~javascript
-
+```javascript
 var express = require("express");
 var app = express();
 
@@ -48,11 +47,11 @@ app.get('/', function(req, res) {
 });
 
 app.listen(3000);
-~~~
+```
 
 Create a file called "package.json" with the following contents;
 
-~~~json
+```json
 {
   "name": "hello-node",
   "version": "0.0.1",
@@ -63,53 +62,52 @@ Create a file called "package.json" with the following contents;
     "node": "0.8.x"
   }
 }
-~~~
+```
 
 This file tells node which libraries are in use (express, in this case) and what versions to use. The engines configuration can also be used to specify which version of node to use, although this is also selected using VMC when deploying the application. For a more detailed explanation of package.json, take a look at https://npmjs.org/doc/json.html
 
 ## <a id='dependencies'></a>Dependencies, NPM and package.json ##
 
 Install the modules declared as dependencies in package.json using NPM
 
-~~~console
+<pre class="terminal">
 $ npm install
-~~~
+</pre>
 
 This should create a "node_modules" folder that contains the application's dependencies.
 
 Start the application as a local and server and check it's output
 
-~~~console
+<pre class="terminal">
 $ node app.js
-~~~
+</pre>
 
 Open a browser and navigate to http://localhost:3000, or, alternatively use "curl" in another shell
 
-~~~console
+<pre class="terminal">
 $ curl http://localhost:3000
-~~~
+</pre>
 
 You should see the output - "Hello from Cloud Foundry"
 
 ## <a id='deploy-your-app'></a>Deploying your application ##
 
 With VMC installed, target your desired Cloud Foundry instance and login
 
-~~~console
+<pre class="terminal">
 $ vmc target api.cloudfoundry.com
 Setting target to https://api.cloudfoundry.com... OK
 
 $ vmc login
-~~~
+</pre>
 
 Deploy the application by using the "push" command, notice the URL "hello-node.cloudfoundry.com" was taken, so it was changed to hello-node2.cloudfoundry.com
 All the other options were left as the default by pushing enter.
 
-~~~console
+<pre class="terminal">
 $ vmc push
 
 Name> hello-node
-
 Instances> 1
 
 1: node
@@ -157,22 +155,22 @@ Save configuration?> n
 Uploading hello-node... OK
 Starting hello-node... OK
 Checking hello-node... OK
-~~~
+</pre>
 
 Finally check your application has deployed correctly, navigating to the configured URL.
 
 ## <a id='checking-node-versions'></a>Node.js version parity ##
 
 It's important to make sure that the version of Node.js used on your computer is the same as the version you use when deploying to Cloud Foundry. Check your local version, like so;
 
-~~~console
+<pre class="terminal">
 $ node -v
 v0.8.2
-~~~
+</pre>
 
 In this instance you can see the installed version is 0.8.2, so when deploying we would select "node08" for the runtime. To see a list of available runtimes using VMC, use the following command;
 
-~~~console
+<pre class="terminal">
 $ vmc info --runtimes
 
 Getting runtimes... OK
@@ -185,7 +183,7 @@ node06    0.6.8
 node08    0.8.2      
 ruby18    1.8.7p357  
 ruby19    1.9.2p180  
-~~~
+</pre>
 
 ## <a id='next-steps'></a>Next steps - Binding a service ##
 

diff --git a/source/docs/using/deploying-apps/jvm/index.html.md b/source/docs/using/deploying-apps/jvm/index.html.md
@@ -2,10 +2,10 @@
 title: Using Cloud Foundry - Java and the JVM
 ---
 
-# Using Cloud Foundry - Java and the JVM
+## Using Cloud Foundry - Java and the JVM
 
 
-## Frameworks 
+### Frameworks
 
 Spring
 

diff --git a/source/docs/using/deploying-apps/ruby/index.html.md b/source/docs/using/deploying-apps/ruby/index.html.md
@@ -2,10 +2,10 @@
 title: Using Cloud Foundry - Ruby
 ---
 
-# Using Cloud Foundry - Ruby
+## Using Cloud Foundry - Ruby
 
 
-## Frameworks 
+### Frameworks
 
 Rails
 

diff --git a/source/docs/using/managing-apps/index.html.md b/source/docs/using/managing-apps/index.html.md
@@ -2,6 +2,8 @@
 title: Managing Applications
 ---
 
+## Managing Applications
+
 A brief introduction to STS and VMC
 
 [VMC](vmc/index.html)

diff --git a/source/docs/using/managing-apps/sts/index.html.md b/source/docs/using/managing-apps/sts/index.html.md
@@ -0,0 +1,7 @@
+---
+title: STS
+---
+
+## Spring Tool Suite
+
+Coming soon...
diff --git a/source/docs/using/managing-apps/vmc/index.html.md b/source/docs/using/managing-apps/vmc/index.html.md
@@ -0,0 +1,7 @@
+---
+title: vmc
+---
+
+## vmc
+
+Coming soon...