Commit Graph

12 Commits

Author SHA1 Message Date
Antoine Vandevenne (anv)
17df8c547a [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#2064
2022-05-20 14:10:01 +02:00
luvi
1f84bab97d [ADD] developer: scroller service added
This commit adds the documentation related to
the scroller service. This service is used for
the webclient to handle clicks on links and there
were no documentation related until now.

closes odoo/documentation#1313

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-19 11:36:52 +00:00
Simon Genin (ges)
bbc85e148e [ADD] developer: add js http service
closes odoo/documentation#1293

Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-11-09 16:56:01 +00:00
Géry Debongnie
624131f712 [IMP] developer: document formatters/parsers registries
and add entry for effects registry as well

closes odoo/documentation#1300

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-08 16:00:37 +00:00
Géry Debongnie
11171da6b1 [IMP] developer: add section on router service
closes odoo/documentation#1292

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-05 14:15:36 +00:00
Géry Debongnie
d551193391 [IMP] developer: add missing links in js doc
and slightly improve effect registry page

closes odoo/documentation#1296

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-05 10:12:35 +00:00
Géry Debongnie
894165a949 [IMP] developer: normalize reference in js doc
The preferred format for (frontend) references is now:
"frontend/filename/section", or something close to that.

closes odoo/documentation#1291

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-04 13:43:37 +00:00
Simon Genin (ges)
d72c3fdd8b [ADD] developer: effect service
closes odoo/documentation#1210

Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-11-03 09:00:43 +00:00
Géry Debongnie
1e6c12be30 [IMP] developer: improve section on env
- add a link to services
- add a note that the env is quite powerful
- reformat the table with the list-table role, to make it easier to edit

closes odoo/documentation#1249

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-03 08:36:04 +00:00
Géry Debongnie
4082906776 [IMP] developer: reorder and improve notification service
closes odoo/documentation#1265

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-03 08:25:52 +00:00
Géry Debongnie
b4fce0a13d [IMP] developer: add section on cookie service
and slightly improve notification information

closes odoo/documentation#1241

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-02 19:55:52 +00:00
Géry Debongnie
a76e505892 [IMP] developer: rename addons/js => backend/frontend
The terminology did not really make sense for a lot of these sub pages.
This change should have been done long ago, but was probably delayed
because some people in Odoo call the web client the "backend", which is
really misleading.

This commit also renames the title "Reference Guides" to "Reference",
since this section does not contain any guides anyway.

Part-of: odoo/documentation#1243
2021-11-02 13:42:38 +00:00