From d81462eeac61f4f83fc822b2fc2314f651ae4a9b Mon Sep 17 00:00:00 2001 From: Alex Heneveld Date: Thu, 12 Jan 2012 14:37:31 +0000 Subject: [PATCH 1/8] ignore any .project we create when editting in IDE --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index ca35be0..78fd845 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ _site +.project From 7892d0b4168e545e8b0ce4826b4d0ec2bee6dc29 Mon Sep 17 00:00:00 2001 From: Alex Heneveld Date: Thu, 12 Jan 2012 14:38:12 +0000 Subject: [PATCH 2/8] remove extended ASCII chars (replace A0 with   and A9 with ©) ... i think having these in is asking for trouble (they break in jekyll --server FWIW) ... unless someone knows otherwise ? --- index.html | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/index.html b/index.html index fe74809..4f5446c 100755 --- a/index.html +++ b/index.html @@ -12,15 +12,15 @@ @@ -142,7 +142,7 @@

WHY SHOULD I USE JCLOUDS?

From 961af215f5b1632f095a7ead0fdbb1a3ff200371 Mon Sep 17 00:00:00 2001 From: Alex Heneveld Date: Thu, 12 Jan 2012 15:43:54 +0000 Subject: [PATCH 3/8] made these instructions a little more complete based on my experience --- documentation/devguides/contributing-to-documentation.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/documentation/devguides/contributing-to-documentation.md b/documentation/devguides/contributing-to-documentation.md index 5b0f3e4..9a563e8 100644 --- a/documentation/devguides/contributing-to-documentation.md +++ b/documentation/devguides/contributing-to-documentation.md @@ -21,14 +21,13 @@ To change or contribute to the documentation: More about the site: -As indicated above, the site is built using [github pages](http://pages.github.com/) - which is built using Jekyll[2], -a static site generator written ruby. Jekyll. +As indicated above, the site is built using [github pages](http://pages.github.com/) which uses [Jekyll](https://github.com/mojombo/jekyll/), a static site generator written in Ruby, under the covers. To preview any changes you make, install Jekyll (from [here](https://github.com/mojombo/jekyll/wiki/install), with Pygments too) then run `jekyll -pygments --safe --server` and open [localhost:4000](http://localhost:4000) in the browser. The site structure is pretty simple as you can see in the [source of this site](https://github.com/jclouds/jclouds.github.com). The *_layouts* folder contains the docs.html file which is used as the layout - containing main column and the sidebar. The sidebar is an *include* which is inside the *_includes folder*. -`(Due a bug the sidebar can't be a markdown file, but this will be changed as soon as the bug is fixed).` +(Due a bug the sidebar can't be a markdown file, but this will be changed as soon as the bug is fixed. Also when running in the jekyll server, links without the .html are not resolved, and you'll have to manually append `.html` to some links; this runs fine on the server, so don't worry about it; however if you know a better way please let us know!) Each folder under the documentation contains an *index.markdown* that will list all the pages that belong to this "section". You can even edit the pages directly on github if you don't want to From 977c4f4e9d9349f2d0fc4c65cd0529d6b7e3e988 Mon Sep 17 00:00:00 2001 From: Alex Heneveld Date: Thu, 12 Jan 2012 15:44:27 +0000 Subject: [PATCH 4/8] blocks didn't look nice, they were tiny; though 
 blocks looked beautiful; have changed inline code blocks to use same
 droid font, and now looking good (chrome os x)

---
 style/style.css | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/style/style.css b/style/style.css
index 72a711f..1b040ec 100755
--- a/style/style.css
+++ b/style/style.css
@@ -305,3 +305,6 @@ pre {
 	width: 512px;
 	font-size: 150%;
 }
+code {
+ 	font-family: 'Droid Sans Mono', sans-serif;
+}

From fa3c70e066a5b9fea2ae1acb8493f903dde8d61f Mon Sep 17 00:00:00 2001
From: Alex Heneveld 
Date: Thu, 12 Jan 2012 15:49:15 +0000
Subject: [PATCH 5/8] created a wee "j" favicon for the docs site

---
 favicon.ico | Bin 0 -> 1150 bytes
 1 file changed, 0 insertions(+), 0 deletions(-)
 create mode 100644 favicon.ico

diff --git a/favicon.ico b/favicon.ico
new file mode 100644
index 0000000000000000000000000000000000000000..219691f2ebf738b89257b9c6b36fda5dcbe5a3f9
GIT binary patch
literal 1150
zcmZQzU<5(|0R}M0U}0bo1F|%L7$l?s#Ef7P$N}DkW|4Gmf(hGJk8Tvu~2l)XUUZm
Date: Thu, 12 Jan 2012 16:42:46 +0000
Subject: [PATCH 6/8] change header formatting so hierarchy stands out better
 (esp h3 cf h2) without relying on local browser styles, tweaks to
 spacing/margins to make more consistent

---
 style/style.css | 38 ++++++++++++++++++++++++++++++++------
 1 file changed, 32 insertions(+), 6 deletions(-)

diff --git a/style/style.css b/style/style.css
index 1b040ec..cae411b 100755
--- a/style/style.css
+++ b/style/style.css
@@ -12,7 +12,7 @@ font-size: 0.68em;
 
 p {
 margin: 0px;
-padding: 0px 0px 16px 0px;
+padding: 8px 0px 8px 0px;
 line-height: 1.2em;
 }
 
@@ -23,8 +23,29 @@ letter-spacing: .1em;
 
 h2 {
 margin: 0px;
-padding: 0px 0px 4px 0px;
+padding: 16px 0px 4px 0px;
+font-size: 120%; 
+}
+
+h3 {
+margin: 0px;
+padding: 8px 0px 4px 0px;
+font-size: 100%; 
+}
+
+h4 {
+margin: 0px;
+padding: 6px 0px 2px 0px;
 font-size: 100%;
+font-style: italic;
+}
+
+h5 {
+margin: 0px;
+padding: 4px 0px 2px 0px;
+font-size: 100%;
+font-weight: normal;
+font-style: italic;
 }
 
 img {
@@ -61,24 +82,24 @@ border-left: 8px solid;
 
 /* unordered list */
 ul {
-margin: 8px 0px 0px 16px;
+margin: 6px 0px 0px 12px;
 padding: 0px;
 }
 
 ul li {
 list-style-type: square;
-margin: 0px 0px 11px 0px;
+margin: 0px 0px 8px 0px;
 padding: 0px;
 }
 
 /* ordered list */
 ol {
-margin: 8px 0px 0px 24px;
+margin: 6px 0px 0px 18px;
 padding: 0px;
 }
 
 ol li {
-margin: 0px 0px 11px 0px;
+margin: 0px 0px 8px 0px;
 padding: 0px;
 }
 
@@ -255,6 +276,11 @@ border-bottom: 1px dashed;
 border-bottom: 1px solid;
 }
 
+#column2 p a, #column2 p a:hover {
+/* inside a paragraph, underlining with 2px of padding can result in the line below being scored out */
+padding: 0px 0px 0px 0px;
+}
+
 /* contact page - form layout */
 form {
 margin-top: 0px;

From 9f0ee0427bffa4255b289cd7c0b6f3cc8f6cf410 Mon Sep 17 00:00:00 2001
From: Alex Heneveld 
Date: Thu, 12 Jan 2012 16:44:46 +0000
Subject: [PATCH 7/8] minor formatting for "contributing" page

---
 documentation/devguides/contributing-to-jclouds.markdown | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/documentation/devguides/contributing-to-jclouds.markdown b/documentation/devguides/contributing-to-jclouds.markdown
index 5073c09..a0cc125 100644
--- a/documentation/devguides/contributing-to-jclouds.markdown
+++ b/documentation/devguides/contributing-to-jclouds.markdown
@@ -95,7 +95,7 @@ Parameters:
 	
 		*package* 
 		The Java base package of the project's classes.
-		 _same as_ `groupId`.`artifactId` 
+		groupId.artifactId
 		
 	
 	
@@ -128,11 +128,11 @@ you must delete the files this code will replace.  Here are the files:
 		adding compute logger
 	
 	
-		src/main/java/org/jclouds/`artifactId`/`providerName`ContextBuilder
+		src/main/java/org/jclouds/ artifactId/providerNameContextBuilder
 		converts to build a ComputeServiceContext instead of a RestContext
 	
 	
-		src/main/java/org/jclouds/`artifactId`/`providerName`ContextFactory
+		src/main/java/org/jclouds/ artifactId/providerNameContextFactory
 		converts to build a ComputeServiceContext instead of a RestContext
 	
 

From d556bd5fa2896702a2a8c0c852e430b0200863b2 Mon Sep 17 00:00:00 2001
From: Alex Heneveld 
Date: Thu, 12 Jan 2012 21:47:29 +0000
Subject: [PATCH 8/8] fix capitalisation of jclouds

---
 _includes/sidebar.html           | 8 ++++----
 documentation/devguides/index.md | 4 ++--
 documentation/reference/index.md | 6 +++---
 3 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/_includes/sidebar.html b/_includes/sidebar.html
index e53e6a8..c12ad75 100644
--- a/_includes/sidebar.html
+++ b/_includes/sidebar.html
@@ -85,15 +85,15 @@ 
Reference

 
  • Location Metadata Design
    • 
 
  • Compute API Design
    • 
 
  • Columnar Data Design
    • 
-
  • JClouds API
    • 
-
  • JClouds OAuth Integration
    • 
+
  • jclouds API
    • 
+
  • jclouds OAuth Integration
    • 
 
  • Using jclouds with Apache Felix OSGi Container
    • 
 
  • Pool Design
    • 
 
  • Load Balancer Design
    • 
 
  • Logging in jclouds
    • 
 
  • VMWare Integration Approach & Design
    • 
 
  • Supported Providers
    • 
-
  • Apps that use JClouds
    • 
+
  • Apps that use jclouds
    • 
 
  • Using Provider Metadata
    • 
 
 
@@ -104,7 +104,7 @@ 
    Developer Resources
    
 
  • Contributing to jclouds
    • 
 
  • Contributing to Documentation
    • 
 
  • Using Eclipse
    • 
-
  • JClouds Continuous Integration
    • 
+
  • jclouds Continuous Integration
    • 
 
  • Provider Metadata
    • 
 
 
diff --git a/documentation/devguides/index.md b/documentation/devguides/index.md
index fd0f04c..12009c9 100644
--- a/documentation/devguides/index.md
+++ b/documentation/devguides/index.md
@@ -1,6 +1,6 @@
 ---
 layout: docs
-title: JClouds Developer Resources
+title: jclouds Developer Resources
 ---
 
 ### Developer Resources
@@ -8,5 +8,5 @@ title: JClouds Developer Resources
 * [Contributing to jclouds](/documentation/devguides/contributing-to-jclouds)
 * [Contributing to Documentation](/documentation/devguides/contributing-to-documentation)
 * [Using Eclipse](/documentation/devguides/using-eclipse)
-* [JClouds Continuous Integration](/documentation/devguides/continuous-integration)
+* [jclouds Continuous Integration](/documentation/devguides/continuous-integration)
 * [Provider Metadata](/documentation/devguides/provider-metadata)
diff --git a/documentation/reference/index.md b/documentation/reference/index.md
index 7ef6457..2276fd6 100644
--- a/documentation/reference/index.md
+++ b/documentation/reference/index.md
@@ -9,14 +9,14 @@ title: Reference Index
 * [Location Metadata Design](/documentation/reference/location-metadata-design)
 * [Compute API Design](/documentation/reference/compute-design)
 * [Columnar Data Design](/documentation/reference/columnar-datadesign)
-* [JClouds API](/documentation/reference/jclouds-api)
-* [JClouds OAuth Integration](/documentation/reference/oauth)
+* [jclouds API](/documentation/reference/jclouds-api)
+* [jclouds OAuth Integration](/documentation/reference/oauth)
 * [Using jclouds with Apache Felix OSGi Container](/documentation/reference/osgi)
 * [Pool Design](/documentation/reference/pool-design)
 * [Load Balancer Design](/documentation/reference/load-balancer-design)
 * [Logging in jclouds](/documentation/reference/jclouds-logging)
 * [VMWare Integration Approach & Design](/documentation/reference/vmware-integration-design)
 * [Supported Providers](/documentation/reference/supported-providers)
-* [Apps that use JClouds](/documentation/reference/apps-that-use-jclouds)
+* [Apps that use jclouds](/documentation/reference/apps-that-use-jclouds)
 * [Using Provider Metadata](/documentation/reference/using-provider-metadata)
 * [Error Handling](/documentation/reference/error-handling)