diff --git a/doc/source/addons.rst b/doc/source/addons.rst new file mode 100644 index 00000000000..ad46dd2f6fe --- /dev/null +++ b/doc/source/addons.rst @@ -0,0 +1,18 @@ +Developing OpenERP Web Addons +============================= + +* Structure of an addon +* Addons lifecycle (loading, execution, events, ...) + + * Python-side + * JS-side + +* Handling static files +* Overridding a Python controller (object?) +* Overridding a Javascript controller (object?) +* Extending templates + .. how do you handle deploying static files via e.g. a separate lighttpd? +* Python public APIs +* Javascript public APIs +* QWeb templates description? +* OpenERP Web modules (from OpenERP modules) diff --git a/doc/source/development.rst b/doc/source/development.rst new file mode 100644 index 00000000000..5f8c9c5a42b --- /dev/null +++ b/doc/source/development.rst @@ -0,0 +1,10 @@ +Contributing to OpenERP Web +=========================== + +* General organization and core ideas +* Internal documentation, autodoc, Python and JS domains +* QWeb code documentation/description +* Documentation of the OpenERP APIs and choices taken based on that? +* Style guide and coding conventions (PEP8? More) +* Test frameworks for Python and JS? +* Contribution lifecycles (e.g. merge proposals) diff --git a/doc/source/getting-started.rst b/doc/source/getting-started.rst new file mode 100644 index 00000000000..49398a725b6 --- /dev/null +++ b/doc/source/getting-started.rst @@ -0,0 +1,8 @@ +Getting Started with OpenERP Web +================================ + +Installing +---------- + +Launching +--------- diff --git a/doc/source/index.rst b/doc/source/index.rst index caf44666e06..c2399abff55 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,6 +11,12 @@ Contents: .. toctree:: :maxdepth: 2 + getting-started + production + widgets + addons + development + Indices and tables ================== diff --git a/doc/source/production.rst b/doc/source/production.rst new file mode 100644 index 00000000000..a4aeeaa8b93 --- /dev/null +++ b/doc/source/production.rst @@ -0,0 +1,39 @@ +Deploying OpenERP Web +===================== + +In-depth configuration +---------------------- + +SSL, basic proxy (link to relevant section), links to sections and +example files for various servers and proxies, WSGI +integration/explanation (if any), ... + +Deployment Options +------------------ + +Serving via WSGI +~~~~~~~~~~~~~~~~ + +Apache mod_wsgi ++++++++++++++++ + +NGinx mod_wsgi +++++++++++++++ + +uWSGI ++++++ + +Gunicorn +++++++++ + +FastCGI, SCGI, or AJP ++++++++++++++++++++++ + +Behind a proxy +~~~~~~~~~~~~~~ + +Apache mod_proxy +++++++++++++++++ + +NGinx HttpProxy ++++++++++++++++ diff --git a/doc/source/widgets.rst b/doc/source/widgets.rst new file mode 100644 index 00000000000..20e51db7b01 --- /dev/null +++ b/doc/source/widgets.rst @@ -0,0 +1,12 @@ +OpenERP Web as a widgets provider +================================= + +* Using a readonly view as a widget + + * Site example + * iGoogle example + * social site example e.g. Facebook app? + +* Write-access widgets (e.g. contact form) +* Multiple widgets on the same page +* JSON-RPC2 API description for third-parties?