Commit Graph

51 Commits

Author SHA1 Message Date
Claire Bretton (clbr)
38eb13f6dd [IMP] developer/howtos/rdtraining: Add missing information about module category.
Adds explanations and directive for module category creation, so it can be used correctly at res.groups creation.

closes 

X-original-commit: 338fe297b0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-16 16:26:44 +02:00
Julien Castiaux
8c4425e8c9 [IMP] content/developer/webservices
It is hard to find and learn about RPC in Odoo, users hardly know about
JSON-RPC as the only place where we talk about it in deep down in the
*How to make a Module* tutorial.

In the commit, we isolated the tutorial about RPC in a dedicated file,
that file is better referenced thanks to cross-references in some others
places that are talking about RPC

Task: 2884559
X-original-commit: 83c2e6de0b
Part-of: 
2022-09-14 15:18:12 +02:00
Antoine Vandevenne (anv)
128de0e545 [IMP] rdtraining: mention that the second part needs to be completed too
closes 

X-original-commit: 9279fb80a7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-08-01 16:39:18 +02:00
Victor Feyens
0fc36c18e4 [CLN] rdtraining: remove reference to unexisting file
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 

closes 

X-original-commit: 1c4abe4e07
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-25 14:13:55 +02:00
Benoit Socias
78945bf22e [IMP] rdtraining: update float utils information
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

closes 

X-original-commit: b8ee134a28
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-20 13:36:49 +02:00
Victor Feyens
2ed6704b88 [FIX] accounting_localization: use relative paths in csv-table's option
The `file` option for the `csv-table` directive expects relative file
paths rather than absolute file paths since Sphinx 4. Since this was the
only usage of the `ODOO_ABSPATH` placeholder, it is removed with this
commit.

Task - 2898477

closes 

X-original-commit: 60adfacbc9
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-07-14 22:21:58 +02:00
Antoine Vandevenne (anv)
291a3db45c [IMP] developer/rdtraining: simplify the development environment setup
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

closes 

X-original-commit: f75cbca98c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-13 16:48:00 +02:00
Antoine Vandevenne (anv)
12ff9f118b [MOV] developer/misc: move all pages to a more logical location
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

closes 

X-original-commit: 109817311e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-04 16:18:16 +02:00
Valentin Chevalier
2c676ed846 [IMP] developer/howtos: Add missing information about debug mode
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.

closes 

X-original-commit: 96d822bf87
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-27 09:59:58 +02:00
Julien Castiaux
97b7bdfd5e [IMP] rdtraining: tip about -i/-u for odoo-bin
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.

closes 

X-original-commit: 3d2f067e6c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Julien Castiaux <juc@odoo.com>
2022-06-10 21:51:02 +02:00
Antoine Vandevenne (anv)
75e7f29fe1 [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 

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 14:44:52 +02:00
Antoine Vandevenne (anv)
4649c3f8d1 [MOV] content/*: move resource files into their related page's directory
Since , 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: 
2022-05-20 14:44:52 +02:00
Altela Eleviansyah Pramardhika
d67a2492ce [FW][FIX] developer/howtos: Fixed typo from field to fields
closes 

Forward-port-of: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 15:18:56 +02:00
wan
3fb30d87d7 [REF] i18n/localization.rst: rework the entire localization tutorial
closes 

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 13:30:05 +02:00
Altela Eleviansyah Pramardhika
376ee43cf7 [FW][FIX] developer/howtos: missing parentheses in print statement
Added parentheses in a print function

closes 

Forward-port-of: 
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-05-06 11:42:49 +02:00
Adrien Milis
1bee07e966 [FIX] developer/rd-training: fix commands
Changed commands that were still referring to Odoo 14.0 to 15.0

closes 

X-original-commit: b578f575d0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-27 10:06:02 +02:00
Antoine Vandevenne (anv)
44a62e385f [FIX] developer/rdtraining: fix typos
closes 

X-original-commit: f8f5ed93e1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-26 10:54:57 +02:00
Benoit Socias
af27e20e02 [IMP] rdtraining: clarify transition sentence to view inheritance
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

closes 

X-original-commit: 5a39ba7d24
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Benoit Socias (bso) <bso@odoo.com>
2022-04-14 13:43:55 +02:00
Benoit Socias
7462b89f57 [IMP] rdtraining: add note about Settings requiring at least one app
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

X-original-commit: 2ebb7fe802
Part-of: 
2022-04-14 13:43:54 +02:00
Altela Eleviansyah Pramardhika
c4ffa7a8cd [FW][FIX] developer/rdtraining: fix typo
Fixed `name = field.Char(required=True)` to
`name = fields.Char(required=True)`.

closes 

Forward-port-of: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-11 12:39:57 +02:00
Antoine Vandevenne (anv)
9cb3eaa2ef [REL] freeze saas-15.3 branch
closes 

Related: 
Related: 
Related: 
2022-04-11 12:37:49 +02:00
Antoine Vandevenne (anv)
cf6ca0fbb2 [IMP] contributing/doc, install: add an extension for content tabs
In many places in the docs, we need to document several flows that
differ only by a few details. For example, the steps to install Odoo
from the sources are almost identical for Windows, Linux, and Mac OS.
In other places, we'd want to suggest a command in different
environments or programming languages, etc.

This commit thus adds an extension for content tabs (tabs within the
content) to help reduce content repetition in the documentation. As a
proof of concept, the "Packaged installers" and "Source install"
sections of the "Installing Odoo" page are reworked to present their
content within tabs whenever it helps clarify the instructions.

A new python dependency is added as of this commit: `sphinx-tabs`

task-2713983

closes 

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Lucie Van Nieuwenhuyse (luvn) <luvn@odoo.com>
2022-02-07 16:44:01 +00:00
boan-odoo
64fd4bbd0a [IMP] rdtraining: add links from enterprise wiki
Select links and pieces of information from Odoo Enterprise wiki
were copied over at the end Chap. 2 of the functional training.

These would be useful to have during the tutorial instead of at
the end of it.

closes 

X-original-commit: a9bc16bec8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 13:38:02 +00:00
Jennafer
3d74c4584b [FW][FIX] rdtraining: use "deprecate" rather than "depreciate"
Fixed one typo - "depreciated" to "deprecated"

closes 

Forward-port-of: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-26 17:53:23 +00:00
Christophe Monniez
aa1c6b3f07 [IMP] install/setup: install dependencies from debian packages
This commit changes the way that Odoo python dependencies should be
installed.

Before this commit, the described way to install Odoo dependencies was
by using the `pip` utility.

Now, we explicitly recommend to use a Debian based system and install
Odoo dependencies from their packaging tool.

The main reasons are:
* Odoo productions instances are, most of the time, run on Debian based
  systems with those package already installed
* That way, a developer cannot mistakenly use a feature from a
  dependency that does not exists on those production environments
* Avoid mixes of python packages on the developer/user 's system

closes 

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-17 12:28:55 +00:00
poma-odoo
c1e85cb5f0 [FW][FIX] developer/rdtraining: comply with the guidelines for report naming
The suggested folder structure does not comply with guidelines:
https://www.odoo.com/documentation/15.0/developer/misc/other/guidelines.html#file-naming

> Concerning printable reports which contain mainly data preparation and Qweb templates naming is
the following :

    addons/plant_nursery/
    |-- report/
    |   |-- plant_order_reports.xml (report actions, paperformat, ...)
    |   |-- plant_order_templates.xml (xml report templates)

closes 

Forward-port-of: 
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 09:43:11 +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 

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
Adrien Minne
83a3eb5648 [FIX] rdtraining: fix wrong suggested folder for views
The training suggests to put the views in the data/ folder instead of the views/ folder

closes 

X-original-commit: 9d45b861c0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-15 08:53:05 +00:00
luxiaochuang
07f5559efe [FIX] howtos: remove useless <group/> tag from training example
closes 

X-original-commit: cf1504258e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 08:21:53 +00:00
frln
bbaa1856c5 [IMP] administration/install, *: make 3.7 the minimum version for Python
As of commit https://github.com/odoo/odoo/commit/794677fb Python 3.7 is
the minimum required version for Python when running Odoo 15.0.

This also applies to building the version 15.0 of the documentation.

closes 

X-original-commit: 26042f541a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-02 13:33:55 +00:00
Tiffany Chang (tic)
9195e02602 [IMP] developer/{howtos,reference}: update training to match v15 changes
- Reference v15 training solutions
- Refer to Command namespace instead of triplets (e.g.
  Command.create(values) instead of (0, 0, values)
- Add notice about OWL transition
- Add reference to @api.ondelete (instead of override unlink())
- Remove references to SavepointCase (now only TransactionCase) from
  unit test topic

- Also add missing reference documentation for ondelete

closes 

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 14:06:01 +02:00
Tiffany Chang (tic)
c0aba501da [IMP] developer/howtos: proofread adv topics
- Cleaned up the language a tiny bit
- Fixed small errors/typos
- Add some missing info for dashboard topic
- Updated unit test exercise to match what's in the solutions repo

Part-of: 
2021-10-05 14:06:01 +02:00
Tiffany Chang (tic)
c1b8e7f7a1 [IMP] developer/howtos: encourage linters more
There have been complaints of newbies not setting up their linters
therefore let's emphasize their use/setup more in the tutorial and hope
for the best.

Part-of: 
2021-10-05 14:06:01 +02:00
AdrienPr
28359b6bd6 [FIX] dev/howtos/themes: correct wrong code example
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
2021-07-22 14:43:16 +02:00
Antoine Vandevenne (anv)
be1653cc51 [MERGE] Forward-port of branch 13.0 to 14.0 2021-07-07 15:39:35 +02:00
Ivan Yelizariev
5b59088a71 [IMP] rdtraining: no need to add web to dependencies
`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
2021-06-21 15:00:35 +02:00
Victor Feyens
7c3106e95c [IMP] dev/howtos: hide deprecated and outdated tutorial
Now that the new rd&training is deployed, we shouldn't highlight this page anymore

Fixes 
2021-06-09 11:45:39 +02:00
Gabo
525d05e068 [FIX] developer/howtos: wizard example 2021-06-09 10:14:17 +02:00
Ivan Yelizariev
8b201ca924 [IMP] developer/*: clarify --test-tags
Corresponding PRs to odoo/odoo:

https://github.com/odoo/odoo/pull/71130
https://github.com/odoo/odoo/pull/71331

---

task-2431630
2021-06-07 09:39:06 +02:00
Victor Feyens
a1e7024fa0 [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-31 15:16:09 +02:00
Victor Feyens
40afc9d9f0 [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-31 14:54:23 +02:00
Victor Feyens
e96bc804d3 [FIX] content/developer/*: typos
Found with codespell
2021-05-31 14:44:18 +02:00
Ivan Yelizariev
86cefde583 [FIX] rdtraining: improve git commands
no need to fetch all branches from odoo/technical-training-sandbox

Also, ``git push`` without upstream may not work depending on git
version/configuration:

```
$ git push -u master-my_first_branch-IEL
fatal: The current branch master-my_first_branch-IEL has no upstream branch.
To push the current branch and set the remote as upstream, use

    git push --set-upstream master-my_first_branch-IEL master-my_first_branch-IEL
```
2021-05-25 14:37:47 +02:00
Victor Feyens
d0c2cb17bc [ADD] developer/howtos: R&D Training
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>
2021-05-18 15:24:16 +02:00
Victor Feyens
1ef5267a02 [FIX] developer/howtos/backend: missing reference
Lost during forward-ports
2021-05-11 15:40:20 +02:00
Victor Feyens
6aea496f26 [MERGE] Forward-port of branch 13.0 to 12.0 2021-05-11 15:25:37 +02:00
Victor Feyens
3d9afc4c0e [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-11 15:13:58 +02:00
Victor Feyens
ac99ad7abd [REM] *: patchqueue extension
Remove the patchqueue extension from the doc requirements since it isn't 
maintained anymore (raising warnings for recent sphinx versions) and the 
patches to specify code blocks aren't easy to maintain.

Remove hidden code patches, and replaces shown patches by code block / 
literalincludes to keep the useful content.
2021-05-10 17:24:23 +02:00
Antoine Vandevenne (anv)
74c9f94d16 [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-04 16:51:07 +02:00
Antoine Vandevenne (anv)
8a6ad77935 [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-04 16:31:06 +02:00