From 411c322f30b3d3ee6706798fe5b60d5504a681a1 Mon Sep 17 00:00:00 2001 From: FND Date: Fri, 28 Sep 2012 15:36:10 +0200 Subject: [PATCH 1/2] added missing RedCloth dependency --- Gemfile | 3 ++- Gemfile.lock | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/Gemfile b/Gemfile index 9a72280..a4f1f7c 100644 --- a/Gemfile +++ b/Gemfile @@ -1,4 +1,5 @@ source :rubygems gem "jekyll" -gem "ruby-xslt" \ No newline at end of file +gem "ruby-xslt" +gem "RedCloth" diff --git a/Gemfile.lock b/Gemfile.lock index 020ac1e..6bec8cf 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,6 +1,7 @@ GEM remote: http://rubygems.org/ specs: + RedCloth (4.2.9) albino (1.3.3) posix-spawn (>= 0.3.6) classifier (1.3.3) @@ -26,5 +27,6 @@ PLATFORMS ruby DEPENDENCIES + RedCloth jekyll ruby-xslt From ae579005c2df37a5e00835bcf3e823c26c2ceb7d Mon Sep 17 00:00:00 2001 From: FND Date: Fri, 28 Sep 2012 15:52:49 +0200 Subject: [PATCH 2/2] converted HTML to Markdown (where possible) note that this is only possible for about half the document, as the rest requires custom attributes - still seems worth it though in the process, fixed some seemingly invalid HTML in the footer (highlighted by Maruku; validator.w3.org seems down right now, so I can't confirm) --- index.html => index.md | 85 +++++++++++++++++++++++++----------------- 1 file changed, 50 insertions(+), 35 deletions(-) rename index.html => index.md (76%) diff --git a/index.html b/index.md similarity index 76% rename from index.html rename to index.md index c1d0762..60e3ed4 100644 --- a/index.html +++ b/index.md @@ -2,28 +2,34 @@ layout: default title: "ROCA: Resource-oriented Client Architecture" --- -

Introduction

-

A Web application's architecture is heavily influenced by the - design decisions, both implicit and explicit, that have been - made by framework developers. Sometimes these decisions are - consciously accepted as being in line with the intended overall - system architecture. More often, though, they are accepted - simply because developers assume they embody the state of the - art of development practices. -

-

ROCA is an attempt to define a set of recommendations — - independent of any particular framework, programming language, - or tooling — that embodies the principles of what we consider to - be good web application architecture. Its purpose is to serve as - a reference, one that can be implemented as-is or be compared to - other approaches to highlight diverging design - decisions. -

-

Mandatory Requirements

-

A web application's architecture is compliant to the ROCA - style if it meets all of the following mandatory requirements: -

+ +Introduction +------------ + +A Web application's architecture is heavily influenced by the +design decisions, both implicit and explicit, that have been +made by framework developers. Sometimes these decisions are +consciously accepted as being in line with the intended overall +system architecture. More often, though, they are accepted +simply because developers assume they embody the state of the +art of development practices. + +ROCA is an attempt to define a set of recommendations — +independent of any particular framework, programming language, +or tooling — that embodies the principles of what we consider to +be good web application architecture. Its purpose is to serve as +a reference, one that can be implemented as-is or be compared to +other approaches to highlight diverging design +decisions. + + +Mandatory Requirements +---------------------- + +A web application's architecture is compliant to the ROCA +style if it meets all of the following mandatory requirements: +
  1. The server application adheres to REST principles, i.e. the server exposes a set of @@ -43,7 +49,7 @@

    Mandatory Requirements

    redundantly on both the client and the server. Thus, due to the requirement above, application logic must not reside on the client-side. - [must-no-duplication] + [must-no-duplication]
  2. It must be possible to use the server's logic through user agents other than a browser, @@ -73,8 +79,12 @@

    Mandatory Requirements

-

Suggested Practices

-

The following concepts are encouraged, but not mandatory:

+ +Suggested Practices +------------------- + +The following concepts are encouraged, but not mandatory: +
  1. Resources have additional representations in other formats, e.g. JSON and/or XML. [should-formats] @@ -97,8 +107,11 @@

    Suggested Practices

-

Violations

-

The following characteristics are clear indications that the ROCA style is violated:

+Violations +---------- + +The following characteristics are clear indications that the ROCA style is violated: +
  1. Cookies are used for purposes other than @@ -165,13 +178,15 @@

    Violations

-
- - - Creative Commons License
-ROCA is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License. - +
+

+ + Creative Commons License + +
+ ROCA is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License. +