Commit Graph

23 Commits

Author SHA1 Message Date
Julien Castiaux
0f2b82cb37 [IMP] install/deploy: serve static file/attachment
Odoo is compatible with X-Sendfile (apache) and X-Accel (nginx). They
are web server extension that can be used by the web application (Odoo)
to delegate serving local files to the web server (apache/nginx). We use
those extension to stream attachments. The documentation now explains
what is X-Sendfile/X-Accel and how to configure each web server.

Along those changes, the few sentences about serving static files have
been reworded and now include various configuration examples.

closes odoo/documentation#2083

Task: 2801675
Related: odoo/odoo#88134
Related: odoo/enterprise#26191
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-01 02:53:55 +02:00
Antoine Vandevenne (anv)
4887907ef7 [MOV] developer/api/odoo: rename odoo.rst into external_api.rst
The previous file name was not very relevant in regard to the content of
the page, and it conflicted with the `sys.path`.

closes odoo/documentation#2068

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 14:18:54 +02:00
Antoine Vandevenne (anv)
8722ea902e [MOV] content/*: move resource files into their related page's directory
Since odoo/documentation#903, the guideline for the location of new
resource (images, downloadable files, RST includes...) files is to place
those inside the directory of the RST page that references them.

For example, if `doc1.rst` has a reference to `image.png` and to
`download.zip`, the file structure should look like this:

├── parent_doc/
│     └── doc1/
│     │     └── image.png
│     │     └── download.zip
│     └── doc1.rst
│     └── doc2.rst
├── parent_doc.rst

Before this commit, most of the resource files were still located inside
'media' directories holding all the resource files referenced by RST
pages located at the same level as these directories. In the example
above, a single 'media' directory would hold all the resource files
referenced by both `doc1.rst` and `doc2.rst`. Doing so prevented us from
figuring out easily which resource file was referenced by which RST page
and, thus, lead to unused resource files piling up in the repository. It
also made it more complicated to define codeowners regex rules because a
team could not simply be assigned to `/some_page.*` but needed to be
assigned to both `/some_page\.rst` and to the location of 'media'.

In order to help new content writers figure out the guideline when
taking examples from other RST pages, this commit retroactively applies
the guideline to existing resource files and 'media' directories. The
left-over resource files that are not referenced by any RST page are
removed.

task-2497965

Part-of: odoo/documentation#2068
2022-05-20 14:18:54 +02:00
wan
889c9cf0f9 [REF] i18n/localization.rst: rework the entire localization tutorial
closes odoo/documentation#1969

X-original-commit: 9db567159d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: William André (wan) <wan@odoo.com>
Co-authored-by: William Andre <wan@odoo.com>
Co-authored-by: Ivan Yelizariev <iel@odoo.com>
2022-05-09 14:03:24 +02:00
Thibault Francois
e6d9a9dac2 [IMP] CLI: adapt cloc doc to new behavior
since https://github.com/odoo/odoo/pull/85854 cloc
also count stylesheet file and frontend file in
imported module

closes odoo/documentation#1734

X-original-commit: d2de65a15a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-22 12:00:48 +01:00
0b11001111
cadf860b42 [IMP] developer: extend internationalization guide
In order for javascript translations to become active, the corresponding
addon needs to follow a certain naming scheme or register explicitly.
This commit updates the internationalization guide with a respective
hint.

Fixes odoo/documentation#1676

closes odoo/documentation#1727

X-original-commit: 112b6c1267
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2022-03-18 17:05:10 +01:00
bve-odoo
279dc5a623 [FIX] dev/misc/cmdline: update url werkzeug
URL was pointing to a dead end.
Update from
http://werkzeug.pocoo.org/docs/contrib/fixers/#werkzeug.contrib.fixers.ProxyFix
to
https://werkzeug.palletsprojects.com/en/0.16.x/middleware/proxy_fix/#module-werkzeug.middleware.proxy_fix
new URL as we are using 0.16.1

closes odoo/documentation#1709

X-original-commit: 7ce175ff55
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-17 11:48:40 +01:00
Antoine Vandevenne (anv)
7316152764 [IMP] developer/cli: mention the different ways of calling the CLI
All examples on the page suggest calling the CLI with "odoo-bin" while
it is recommended to call it with "odoo" when Odoo was installed from a
distribution package. It also failed to mention the location of
"odoo-bin" relative to the source files.

The chance is also taken to rename the somewhat unclear page title to
something more clear and generic.

closes odoo/documentation#1699

X-original-commit: c018a53686
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-14 11:28:56 +00:00
Antoine Vandevenne (anv)
7b9bb78801 [IMP] developer/api/extract_api: rework page to get rid of switchers
task-2787415

closes odoo/documentation#1692

X-original-commit: 85b7200944
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-11 14:44:47 +00:00
Antoine Vandevenne (anv)
4721c7291f [IMP] developer/api/odoo: rework page to use examples and content tabs
task-2787415

X-original-commit: 1afdec3784
Part-of: odoo/documentation#1692
2022-03-11 14:44:46 +00:00
Yajo
2c72491158 [FIX] discuss, cmdline: update for static outgoing mail addresses
This changed for Odoo 15.0 in odoo/odoo#61853 and the docs didn't
reflect that change.

MT-52 @moduon

closes odoo/documentation#1469

X-original-commit: 084fb777f9
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-13 12:09:21 +00:00
Ivan Yelizariev
2c4bfb12c2 [IMP] cmdline: add note about --dev=xml
closes odoo/documentation#1066

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 09:33:44 +00:00
Antoine Vandevenne (anv)
915f1805fd [IMP] developer/*: replace occurrences of "access rule" by "record rule"
Both the functional and technical name of the `ir.rule` model is "Record
Rule". This commit makes sure that all occurrences of "Access Rule" are
replaced by the correct name "Record Rule" as it was easily confused
with "Access Rights".

Original PR: https://github.com/odoo/documentation/pull/1118

closes odoo/documentation#1424

X-original-commit: a692dbdc9c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 09:27:29 +00:00
Chris Parker
3ed9b8d435 [FIX] api/odoo: reflect the correct location of menu actions
closes odoo/documentation#1413

X-original-commit: beb92c9f18
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 12:08:40 +00:00
Antoine Vandevenne (anv)
f29549b144 [FIX] extract_api: bring back extract_api doc lost with be1653cc
closes odoo/documentation#1199

X-original-commit: 59df6b90ae
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-20 07:38:46 +00:00
“odoo-frc”
fe1065b044 [IMP] iap_tools: Update doc about iap_charge & authorize
closes odoo/documentation#1101

Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
2021-08-17 11:58:21 +00:00
Donatienne Pirlot (dopi)
f0550c30c6 [REM] developer/upgrade: remove outdated page
task-2613841

closes odoo/documentation#1082

X-original-commit: eee063a8b1
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
2021-08-03 14:35:58 +00:00
Antoine Vandevenne (anv)
d9620d54e7 [MERGE] Forward-port of branch 14.0 to master 2021-07-20 12:57:18 +02:00
Antoine Vandevenne (anv)
6594686062 [MERGE] Forward-port of branch 13.0 to 14.0 2021-07-20 12:55:24 +02:00
Valentin Chevalier
d30cb941c5 [IMP] guidelines: remove a deprecated tag
The 'oldname' tag has been deprecated for a few years
2021-07-09 10:51:13 +02:00
Antoine Vandevenne (anv)
f8f784c0b0 [MERGE] Forward-port of branch 14.0 to master 2021-07-07 15:40:27 +02:00
Antoine Vandevenne (anv)
be1653cc51 [MERGE] Forward-port of branch 13.0 to 14.0 2021-07-07 15:39:35 +02:00
Fabien Pinckaers
16418c020b [IMP] *: introduce tables of contents in top-level app pages 2021-07-07 14:56:38 +02:00