The referenced `bypass.py` file isn't specified anywhere in
the training documentation or code content.
The paragraph is removed to avoid meaningless searches and
confusing trainees.
This commit also adds a missing parenthese in the preceding
code content.
Fixes#2488closesodoo/documentation#2518
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The warning about float utils does not state where to find them, and
they are preceded by an example in the code that infringes the warning's
recommendation.
This commit indicates where to find the float utils and replaces the
example by one that uses them.
task-2925402
closesodoo/documentation#2507
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
In an attempt to help new developers install Odoo with a
straightforward procedure, Chapter 2 of the "Getting started" tutorial
included copy-pastes of parts of the "Installing Odoo" page. This proved
to be inefficient because it required maintaining documentation on the
installation procedure in several places and misled the readers by
suggesting installing the Python requirements *after* installing
PostgreSQL.
With this commit, the page on Chapter 2 is refreshed to be clearer to
the readers and redirect them to the "Installing Odoo" page when
necessary.
task-2908434
closesodoo/documentation#2380
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Before this commit, the "Developer/Misc" directory of the doc, and
more particularly the "Developer/Misc/Other" sub-directory, was used as
a garbage dump where we moved all the pages that didn't fit elsewhere.
Due to that, interesting and important pages, such as the Coding
Guidelines, were buried in that directory never to be read again by Odoo
developers.
This commit moves most pages under "Misc" one or two levels up to be
located directly under "Developer" hence making them more accessible. A
new "Contributing/Development" directory is added to host the Coding
Guidelines page and soon many other pages.
task-2897143
closesodoo/documentation#2350
X-original-commit: ad374af15d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The documentation of view attributes was lacking visual structure to
help the reader figure out which attribute relates to which parent
element. Since this documentation was relying on RST block quotes to
represent the hierarchy of view attributes, we can apply the same new
styling that was added with commit 934f45cf and designed for autodoc,
and which relies on the exact same HTML structure as block quotes.
task-2755298
closesodoo/documentation#2329
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
In chapter 3 of the developer core training, one is asked to click on a
button that is only shown in debug mode but there is no indication about
this mode in this chapter.
closesodoo/documentation#2286
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
It is never shown to the trainee that he can install/update a module
right from the CLI. Multiple developpers still use the app manager to
install/update their modules multiple months into the job.
closesodoo/documentation#2181
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
The previous file name was not very relevant in regard to the content of
the page, and it conflicted with the `sys.path`.
closesodoo/documentation#2026
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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#2026
The duplicate action is not available for list views
closesodoo/documentation#1855
X-original-commit: ce1961ebaf
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The duplicate action is not available for list views
closesodoo/documentation#1847
X-original-commit: 9cf425d886
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The "View Inheritance" section is introduced by a sentence that can be
understood as "do this task then we'll be ready to go the next section"
instead of "in the next section we will see how to do this task".
This can confuse the reader into thinking that some knowledge was not
acquired in the previous parts.
This commit makes it clear that the task described in the transition
sentence will be achieved in the next part.
task-2822582
closesodoo/documentation#1826
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
At the point when the developer mode is introduced in the training, it is
confusing because the documentation page describes the option inside the
Settings page, but that page only appears if at least one application is
installed. (Otherwise, the Settings app shows the Users instead)
This commit adds a note so that the reader does not start looking for a
screen that cannot be reached at that point.
task-2822582
Part-of: odoo/documentation#1826
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.
Fixesodoo/documentation#1676closesodoo/documentation#1710
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
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.
closesodoo/documentation#1695
X-original-commit: b81c121ea0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
In d46e358d3e88aea9f9289c4845c6c87ab9491c55 some mail.thread method
names were changed: it should be changed in documentation too.
closesodoo/documentation#1682
X-original-commit: b24560e224
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Adding basic information about `How to make a test tour`.
task-2742841
closesodoo/documentation#1516
X-original-commit: f6c1723fe0
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
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/1118closesodoo/documentation#1421
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Syntax was added to explicitly specify a module, class or function with
`--test-tags`: b729a11a12
The documentation was not updated to reflect this, leading to confusion
as people tried to reconcile the documentation with the actual behavior,
without necessarily having seen `odoo-bin --help` which is explicit
about it.
closesodoo/documentation#1279
X-original-commit: 23d0a7a062
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Since the update of the themes tutorial, the id of the snippet template was modified
but this part of the tutorial wasn't updated accordingly.
This commit updates the referenced template id to make sure the tutorial works
as expected.
Finetuning of 08d44d4444
`web` is not used directly and is installed automatically anyway.
Having both `web` and `base` looks excessively, so coaches usually ask to delete
`base`. But more correct solution is adding `base` only. Completly skipping
dependencies is not good either -- see 76e05ccfb8
When searching for a string that can be found in a TOC page's content,
that page is listed in the search results. This is not a wanted behavior
because TOC pages without the 'show-content' metadata directive are not
supposed to be accessible.
This commit adds a 'nosearch' metadata directive to all TOC pages
without a 'show-content' metadata directive, hence removing them from
search results.
task-2527419
