Commits

David Larlet committed b9590ca

Initial documentation

  • Participants
  • Parent commits 50b53ba

Comments (0)

Files changed (1)

-== Welcome ==
-
-Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
-
-=== Wiki features ===
-
-This wiki uses the [[http://www.wikicreole.org/|Creole]] syntax, and is fully compatible with the 1.0 specification.
-
-The wiki itself is actually a hg repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.
-
-Go ahead and try:
-
-{{{
-$ hg clone http://bitbucket.org/david/django-roa/wiki/
-}}}
-
-Wiki pages are normal files, with the .wiki extension. You can edit them locally, as well as creating new ones.
-
-=== Syntax highlighting ===
-
-You can also highlight snippets of text, we use the excellent [[http://www.pygments.org/|Pygments]] library.
-
-Here's an example of some Python code:
-
-{{{
-#!python
-
-def wiki_rocks(text):
-	formatter = lambda t: "funky"+t
-	return formatter(text)
-}}}
-
-You can check out the source of this page to see how that's done, and make sure to bookmark [[http://pygments.org/docs/lexers/|the vast library of Pygment lexers]], we accept the 'short name' or the 'mimetype' of anything in there.
-
-Have fun!
+= Django-ROA (Resource Oriented Architecture) =
+
+=== Turn your models into remote resources that you can access through Django's ORM. ===
+
+Not very clear? A picture is worth a thousand words:
+
+{{http://welldev.org/django-roa-diagram.png|Django-ROA diagram}}
+
+In this diagram, the repository can be whatever you want, the only requirement is that it handles standard HTTP requests. As a developer all you have to do next is to use Django's ORM (connectors are part of Django-ROA).
+
+== What problems does it solve? ==
+
+Here are some ideas:
+
+* data handled by a data warehouse (SOA)
+* multiple database (as you can customize URLs per model)
+* schema-less backend (e.g. CouchDB speaks HTTP)
+* your use-case? :)
+
+== Getting started ==
+
+<<toc GettingStarted 3>>
+
+== Development ==
+
+<<toc Development 3>>
+
+== Need help? ==
+
+=== Discussing ===
+
+You can find me in #django-dev@irc.freenode.net as david`bgk or during EuroDjangoCon or [[http://larlet.com/|through my website]].
+
+=== Declaring bugs ===
+
+<<query  ? Go to the issue tracker>>, verify you request doesn't exist and then submit it.
+
+=== Fixing bugs ===
+
+Use the power of [[http://hgbook.red-bean.com/read/advanced-uses-of-mercurial-queues.html|Mercuria Queues]] and submit your patch(es). Help is really appreciated :-)