Skip to content

Commit cb538eb

Browse files
author
Chloe Jackson
committed
Style and other minor updates
1 parent 2a830a1 commit cb538eb

35 files changed

+416
-105
lines changed

.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,7 @@
1212

1313
# Ignore Sass' cache
1414
/.sass-cache
15+
16+
.idea
17+
/vendor
18+
.DS_Store

Gemfile

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
source :rubygems
22

33
gem "middleman", "~>3.0.10"
4-
gem "redcarpet", "~>2.2.2"
4+
gem "redcarpet", "~>2.2.2"
5+
6+
gem 'middleman-syntax'

Gemfile.lock

+9
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ GEM
5656
middleman-more (>= 3.0.1)
5757
sprockets (~> 2.1, < 2.5)
5858
sprockets-sass (~> 0.9.0)
59+
middleman-syntax (1.0.1)
60+
middleman-core (~> 3.0)
61+
pygments.rb (~> 0.3)
5962
multi_json (1.5.0)
6063
padrino-core (0.10.7)
6164
activesupport (~> 3.2.0)
@@ -66,6 +69,10 @@ GEM
6669
padrino-helpers (0.10.7)
6770
i18n (~> 0.6)
6871
padrino-core (= 0.10.7)
72+
posix-spawn (0.3.6)
73+
pygments.rb (0.3.7)
74+
posix-spawn (~> 0.3.6)
75+
yajl-ruby (~> 1.1.0)
6976
rack (1.4.4)
7077
rack-protection (1.3.2)
7178
rack
@@ -96,10 +103,12 @@ GEM
96103
multi_json (~> 1.3)
97104
url_mount (0.2.1)
98105
rack
106+
yajl-ruby (1.1.0)
99107

100108
PLATFORMS
101109
ruby
102110

103111
DEPENDENCIES
104112
middleman (~> 3.0.10)
113+
middleman-syntax
105114
redcarpet (~> 2.2.2)

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ If you want to contribute on a larger scale, see the [Pivotal Project for CF Doc
2424

2525
**Support**
2626

27-
[suport.cloudfoundry.com](http://suport.cloudfoundry.com)
27+
[support.cloudfoundry.com](http://support.cloudfoundry.com)
2828

config.rb

+3-1
Original file line numberDiff line numberDiff line change
@@ -81,4 +81,6 @@
8181

8282
# Or use a different image path
8383
# set :http_path, "/Content/images/"
84-
end
84+
end
85+
86+
activate :syntax
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Cloud Foundry Architecture
3+
---
4+
5+
## Cloud Foundry Architecture
6+
7+
Coming soon...

source/docs/running/deploying-cf/components/index.html.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
title: BOSH Components
33
---
44

5-
A little text here.
5+
[Intro text here]
66

7-
[Director](director.html)
8-
[Messaging](messaging.html)
9-
[Workers](workers.html)
10-
[Health Monitor](health-monitor.html)
11-
[Stemcell](stemcell.html)
12-
[Agent](agent.html)
13-
[Blobstore](blobstore.html)
14-
[Micro BOSH](micro-bosh.html)
7+
- [Director](director.html)
8+
- [Messaging](messaging.html)
9+
- [Workers](workers.html)
10+
- [Health Monitor](health-monitor.html)
11+
- [Stemcell](stemcell.html)
12+
- [Agent](agent.html)
13+
- [Blobstore](blobstore.html)
14+
- [Micro BOSH](micro-bosh.html)

source/docs/running/deploying-cf/ec2/index.html.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22
title: Deploying Cloud Foundry on EC2
33
---
44

5-
instructions...
5+
## Deploying Cloud Foundry on EC2
6+
7+
Instructions coming soon...

source/docs/running/deploying-cf/index.html.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
title: Deploying to the Cloud with BOSH
33
---
44

5-
An introduction to BOSH here
5+
[An introduction to BOSH here]
66

7-
[components](components/index.html)
8-
[releases](releases/index.html)
9-
[Deploying to EC2](ec2/index.html)
10-
[Deploying to OpenStack](openstack/index.html)
11-
[Deploying to vSphere](vsphere/index.html)
12-
[Monitoring](monitoring/index.html)
7+
- [Components](components/index.html)
8+
- [Releases](releases/index.html)
9+
- [Deploying to EC2](ec2/index.html)
10+
- [Deploying to OpenStack](openstack/index.html)
11+
- [Deploying to vSphere](vsphere/index.html)
12+
- [Monitoring](/docs/running/monitoring/index.html)

source/docs/running/deploying-cf/openstack/index.html.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22
title: Deploying Cloud Foundry on OpenStack
33
---
44

5-
Instructions...
5+
## Deploying Cloud Foundry on OpenStack
6+
7+
Instructions coming soon...

source/docs/running/deploying-cf/releases/index.html.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22
title: Understanding Releases
33
---
44

5-
Etc...
5+
## Understanding Releases
6+
7+
Coming soon...

source/docs/running/deploying-cf/vsphere/index.html.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22
title: Deploying Cloud Foundry on vSphere
33
---
44

5-
Etc...
5+
## Deploying Cloud Foundry on vSphere
6+
7+
Instructions coming soon...

source/docs/running/index.html.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Running Apps on Cloud Foundry
3+
---
4+
5+
## Running Apps on Cloud Foundry
6+
7+
Coming soon...

source/docs/running/monitoring/index.html.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22
title: Monitoring
33
---
44

5-
How to Monitor a Cloud Foundry installation
5+
## Monitoring
6+
7+
How to Monitor a Cloud Foundry Installation (coming soon)

source/docs/using/deploying-apps/custom/index.html.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
title: Introduction to Custom Buildpacks
33
---
44

5-
Etc...
5+
Coming soon...
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Deploying Apps
3+
---
4+
5+
## Deploying Apps
6+
7+
Coming soon...

source/docs/using/deploying-apps/javascript/index.html.md

+20-22
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,15 @@ For the purposes of this tutorial we will build a very simple application that m
3030

3131
Open a shell and create a folder for your application in your desired location
3232

33-
~~~console
33+
<pre class="terminal">
3434
$ cd ~/Projects
3535
$ mkdir hello-node
3636
$ cd hello-node
37-
~~~
37+
</pre>
3838

3939
Create a file called "app.js" with the following contents;
4040

41-
~~~javascript
42-
41+
```javascript
4342
var express = require("express");
4443
var app = express();
4544

@@ -48,11 +47,11 @@ app.get('/', function(req, res) {
4847
});
4948

5049
app.listen(3000);
51-
~~~
50+
```
5251

5352
Create a file called "package.json" with the following contents;
5453

55-
~~~json
54+
```json
5655
{
5756
"name": "hello-node",
5857
"version": "0.0.1",
@@ -63,53 +62,52 @@ Create a file called "package.json" with the following contents;
6362
"node": "0.8.x"
6463
}
6564
}
66-
~~~
65+
```
6766

6867
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
6968

7069
## <a id='dependencies'></a>Dependencies, NPM and package.json ##
7170

7271
Install the modules declared as dependencies in package.json using NPM
7372

74-
~~~console
73+
<pre class="terminal">
7574
$ npm install
76-
~~~
75+
</pre>
7776

7877
This should create a "node_modules" folder that contains the application's dependencies.
7978

8079
Start the application as a local and server and check it's output
8180

82-
~~~console
81+
<pre class="terminal">
8382
$ node app.js
84-
~~~
83+
</pre>
8584

8685
Open a browser and navigate to http://localhost:3000, or, alternatively use "curl" in another shell
8786

88-
~~~console
87+
<pre class="terminal">
8988
$ curl http://localhost:3000
90-
~~~
89+
</pre>
9190

9291
You should see the output - "Hello from Cloud Foundry"
9392

9493
## <a id='deploy-your-app'></a>Deploying your application ##
9594

9695
With VMC installed, target your desired Cloud Foundry instance and login
9796

98-
~~~console
97+
<pre class="terminal">
9998
$ vmc target api.cloudfoundry.com
10099
Setting target to https://api.cloudfoundry.com... OK
101100

102101
$ vmc login
103-
~~~
102+
</pre>
104103

105104
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
106105
All the other options were left as the default by pushing enter.
107106

108-
~~~console
107+
<pre class="terminal">
109108
$ vmc push
110109

111110
Name> hello-node
112-
113111
Instances> 1
114112

115113
1: node
@@ -157,22 +155,22 @@ Save configuration?> n
157155
Uploading hello-node... OK
158156
Starting hello-node... OK
159157
Checking hello-node... OK
160-
~~~
158+
</pre>
161159

162160
Finally check your application has deployed correctly, navigating to the configured URL.
163161

164162
## <a id='checking-node-versions'></a>Node.js version parity ##
165163

166164
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;
167165

168-
~~~console
166+
<pre class="terminal">
169167
$ node -v
170168
v0.8.2
171-
~~~
169+
</pre>
172170

173171
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;
174172

175-
~~~console
173+
<pre class="terminal">
176174
$ vmc info --runtimes
177175

178176
Getting runtimes... OK
@@ -185,7 +183,7 @@ node06 0.6.8
185183
node08 0.8.2
186184
ruby18 1.8.7p357
187185
ruby19 1.9.2p180
188-
~~~
186+
</pre>
189187

190188
## <a id='next-steps'></a>Next steps - Binding a service ##
191189

source/docs/using/deploying-apps/jvm/index.html.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
title: Using Cloud Foundry - Java and the JVM
33
---
44

5-
# Using Cloud Foundry - Java and the JVM
5+
## Using Cloud Foundry - Java and the JVM
66

77

8-
## Frameworks
8+
### Frameworks
99

1010
Spring
1111

source/docs/using/deploying-apps/ruby/index.html.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
title: Using Cloud Foundry - Ruby
33
---
44

5-
# Using Cloud Foundry - Ruby
5+
## Using Cloud Foundry - Ruby
66

77

8-
## Frameworks
8+
### Frameworks
99

1010
Rails
1111

source/docs/using/managing-apps/index.html.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: Managing Applications
33
---
44

5+
## Managing Applications
6+
57
A brief introduction to STS and VMC
68

79
[VMC](vmc/index.html)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: STS
3+
---
4+
5+
## Spring Tool Suite
6+
7+
Coming soon...
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: vmc
3+
---
4+
5+
## vmc
6+
7+
Coming soon...

0 commit comments

Comments
 (0)