The documentation is unclear about the unit used for the --limit-memory-soft
and --limit-memory-hard options of odoo-bin. The unit used is bytes, but
it isn't mentioned and the default unit is shown in mebibytes, causing
confusion.
closesodoo/documentation#5786
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This PR moves the introduction about the different installation methods and editions found on the
install/install.rst page directly under the main install/ page. It creates three pages, one per
installation method documented on the install/install.rst page (Docker being documented on
docker.com and maintained by us), and moves the related content there. In addition, it fixes various
typos/grammar issues and improves the content according to the documentation guidelines. Various
references and links across the documentation had to be fixed accordingly.
task-3459070
closesodoo/documentation#5493
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
The attributes of fields of list views do not mention the `optional`
attribute while it is used by chapter 12 of the R&D Training.
This commit describes this `optional` attribute.
task-3380953
closesodoo/documentation#4823
Signed-off-by: Benoit Socias (bso) <bso@odoo.com>
The deploy documentation is assuming that `/etc/odoo.conf` is the
default config file, which is not the case.
With this commit, the configuration file references the cli
documentation.
closesodoo/documentation#4785
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
RST cleanup to comply with the RST guidelines. This is required so we
can use "make test", as there are currently hundreds of errors. For now,
it is unusable because of the oldest code in this repo.
closesodoo/documentation#3567
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
This commit replaces hard-coded occurrences of the version and of the
last, current and next releases' version with placeholders interpolated
at build time to avoid manually updating these after each freeze.
task-2917614
closesodoo/documentation#3051
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
act_window & report xml tags have been deprecated by
6835aeb0de
two years ago, we should avoid mentioning them in the guidelines.
Furthermore, in 17.0 they won't be available anymore.
closesodoo/documentation#2857
Signed-off-by: Victor Feyens (vfe) <vfe@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>
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>
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>
* readonly is True for related fields.
Since Odoo 12: 52a8ed3c0c
This commit also highlights all the default values of related fields, fixing
the misleading message about related computed in sudo mode (since it can
be disabled with compute_sudo or related_sudo = False)
---
task-2451749
The new R&D training is intended to replace the existing technical
training(s). It is organized as follow:
- A core training, with chapters to follow in order (1 - 16)
- Advanced topics, with independent chapters (A - O)
The advanced topics should be done after the core training.
Co-authored-by: Nicolas Martinelli <nim@odoo.com>
Co-authored-by: Jorge Pinna Puissant <jpp@odoo.com>
Co-authored-by: wan <wan@odoo.com>
Co-authored-by: Xavier Morel <xmo@odoo.com>
Co-authored-by: Tiffany Chang (tic) <tic@odoo.com>
