Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

converted to Markdown #13

Open
wants to merge 2 commits into
base: gh-pages
Choose a base branch
from
Open

converted to Markdown #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
411c322
added missing RedCloth dependency
FND Sep 28, 2012
ae57900
converted HTML to Markdown (where possible)
FND Sep 28, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Gemfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
source :rubygems

gem "jekyll"
gem "ruby-xslt"
gem "ruby-xslt"
gem "RedCloth"
2 changes: 2 additions & 0 deletions Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -26,5 +27,6 @@ PLATFORMS
ruby

DEPENDENCIES
RedCloth
jekyll
ruby-xslt
85 changes: 50 additions & 35 deletions index.html → index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,34 @@
layout: default
title: "ROCA: Resource-oriented Client Architecture"
---
<h2>Introduction</h2>
<p>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.
</p>
<p>ROCA is an attempt to define a set of recommendations &mdash;
independent of any particular framework, programming language,
or tooling &mdash; 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.
</p>

<h2>Mandatory Requirements</h2>
<p>A web application's architecture is compliant to the ROCA
style if it meets all of the following mandatory requirements:
</p>

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 &mdash;
independent of any particular framework, programming language,
or tooling &mdash; 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:

<ol>
<li id="must-rest">The server application adheres to
REST principles, i.e. the server exposes a set of
Expand All @@ -43,7 +49,7 @@ <h2>Mandatory Requirements</h2>
redundantly on both the client and the server.
Thus, due to the requirement above, application logic must not reside
on the client-side.
[<a href="#must-no-duplication" class="anchor">must-no-duplication</a>]
[<a href="#must-no-duplication" class="anchor">must-no-duplication</a>]
</li>
<li id="must-non-browser">It must be possible to use
the server's logic through user agents other than a browser,
Expand Down Expand Up @@ -73,8 +79,12 @@ <h2>Mandatory Requirements</h2>
</li>
</ol>

<h2>Suggested Practices</h2>
<p>The following concepts are encouraged, but not mandatory:</p>

Suggested Practices
-------------------

The following concepts are encouraged, but not mandatory:

<ol>
<li id="should-formats">Resources have additional representations in other formats, e.g.
JSON and/or XML. [<a href="#should-formats">should-formats</a>]
Expand All @@ -97,8 +107,11 @@ <h2>Suggested Practices</h2>
</ol>


<h2>Violations</h2>
<p>The following characteristics are clear indications that the ROCA style is violated:</p>
Violations
----------

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

<ol>
<li id="mustnot-cookies">Cookies
are used for purposes other than
Expand Down Expand Up @@ -165,13 +178,15 @@ <h2>Violations</h2>
</li>
</ol>

<hr />

<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">
<img alt="Creative Commons License"
src="http://i.creativecommons.org/l/by-sa/3.0/88x31.png" /></a><br />
<span xmlns:dct="http://purl.org/dc/terms/"
href="http://purl.org/dc/dcmitype/Text" property="dct:title"
rel="dct:type">ROCA</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution-ShareAlike 3.0 Unported License</a>.

<hr>

<p>
<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">
<img alt="Creative Commons License"
src="http://i.creativecommons.org/l/by-sa/3.0/88x31.png">
</a>
<br>
<span xmlns:dct="http://purl.org/dc/terms/"
href="http://purl.org/dc/dcmitype/Text" property="dct:title"
rel="dct:type">ROCA</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution-ShareAlike 3.0 Unported License</a>.
</p>