[ADD] very basic documentation skeleton with some sections/needs thrown in
bzr revid: xmo@openerp.com-20110318155247-m4lfwzwp43gkesno
This commit is contained in:
parent
9654f60422
commit
60e59e6d8c
|
@ -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)
|
|
@ -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)
|
|
@ -0,0 +1,8 @@
|
|||
Getting Started with OpenERP Web
|
||||
================================
|
||||
|
||||
Installing
|
||||
----------
|
||||
|
||||
Launching
|
||||
---------
|
|
@ -11,6 +11,12 @@ Contents:
|
|||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
getting-started
|
||||
production
|
||||
widgets
|
||||
addons
|
||||
development
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
|
|
|
@ -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
|
||||
+++++++++++++++
|
|
@ -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?
|
Loading…
Reference in New Issue