Commit Graph

29 Commits

Author SHA1 Message Date
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 odoo/documentation#1515

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 odoo/documentation#1496

Forward-port-of: odoo/documentation#1490
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 odoo/documentation#1364

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 odoo/documentation#1426

Forward-port-of: odoo/documentation#1350
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 odoo/documentation#1424

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 odoo/documentation#1418

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 odoo/documentation#1399

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 odoo/documentation#1255

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 odoo/documentation#1146

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: odoo/documentation#1146
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: odoo/documentation#1146
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 #1017
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
Antoine Vandevenne (anv)
e3fee2cf46 [REF][MOV] documentation apocalypse
Prior to this commit, the Odoo documentation was mainly split between
two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits
of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...).
This was causing several problems among which:
  - The theme, config, Makefile, and similar technical resources had to
    be duplicated. This resulted in inconsistent layout, features, and
    build environments from one documentation to another.
  - Some pages did not fit either documentation as they were relevant
    for both users and developers. Some were relevant to neither of the
    two (e.g., DB management).
  - Cross-doc references had to be absolute links and they broke often.
  - Merging large image files in the developer documentation would bloat
    the odoo/odoo repository. Some contributions had to be lightened to
    avoid merging too many images (e.g., Odoo development tutorials).
  - Long-time contributors to the user documentation were chilly about
    going through the merging process of the developer documentation
    because of the runbot, mergebot, `odoo-dev` repository, etc.
  - Some contributors would look for the developer documentation in the
    `odoo/documentation-user` repository.
  - Community issues about the user documentation were submitted on the
    `odoo/odoo` repository and vice-versa.

Merging all documentations in one repository will allow us to have one
place, one theme, one work process, and one set of tools (build
environment, ...) for all of the Odoo docs.

As this is a good opportunity to revamp the layout of the documentation,
a brand new theme replaces the old one. It features a new way to
navigate the documentation, centered on the idea of always letting the
reader know what is the context (enclosing section, child pages, page
structure ...) of the page they are reading. The previous theme would
quickly confuse readers as they navigated the documentation and followed
cross-application links.

The chance is also taken to get rid of all the technical dangling parts,
performance issues, and left-overs. Except for some page-specific JS
scripts, the Odoo theme Sphinx extension is re-written from scratch
based on the latest Sphinx release to benefit from the improvements and
ease future contributions.

task-2351938
task-2352371
task-2205684
task-2352544

Closes #945
2021-05-04 15:44:00 +02:00