Commit Graph

8 Commits

Author SHA1 Message Date
Antoine Vandevenne (anv)
6f125de01b [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

closes odoo/documentation#2006

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 11:33:49 +02:00
bve-odoo
7ce175ff55 [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#1703

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-17 11:16:47 +01:00
Antoine Vandevenne (anv)
b81c121ea0 [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#1693

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-14 10:48:01 +00:00
Antoine Vandevenne (anv)
8fe8ad14a7 [IMP] developer/api/odoo: rework page to use examples and content tabs
task-2787415

closes odoo/documentation#1667

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-10 17:09:18 +00:00
Chris Parker
beb92c9f18 [FIX] api/odoo: reflect the correct location of menu actions
closes odoo/documentation#1409

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 11:40:59 +00:00
Donatienne Pirlot (dopi)
eee063a8b1 [REM] developer/upgrade: remove outdated page
task-2613841

closes odoo/documentation#1080

X-original-commit: 7af926e5aa
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
2021-08-03 14:06:16 +00: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
Fabien Pinckaers
16418c020b [IMP] *: introduce tables of contents in top-level app pages 2021-07-07 14:56:38 +02:00