Commit Graph

48 Commits

Author SHA1 Message Date
samueljlieber
92a39cff3a [FIX] resource folder match
closes odoo/documentation#12063

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2025-02-14 00:18:15 +00:00
samueljlieber
9c7ef9b2cf [FIX] clean unused resource files
Part-of: odoo/documentation#12063
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2025-02-14 00:18:15 +00:00
Sam Lieber (sali)
cb1f1e89d6 [FIX] tutorials: explicit translation function example
closes odoo/documentation#11332

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-12-04 09:36:44 +00:00
vava-odoo
d77d3ace2a [FIX] developer/tutorials/importable_modules: no self in actions
In ir.actions.server, the variable containing the record(s) is not
`self`, but `record` and `records`.
Also, since there is a word about `store` attribute for computed
fields, this commit specifies the behaviour of `readonly` attribute.

closes odoo/documentation#11484

Signed-off-by: Vallaeys Valentin (vava) <vava@odoo.com>
2024-11-29 11:35:53 +00:00
Damien Bouvy
c6a8619367 [ADD] Developer: data module tutorial
Introduce a new tutorial about creating Odoo modules using XML data files
instead of Python code.

This guide is follows closely the 'Server Framework 101' tutorial and
covers the following:

- Module structure and deployment
- Defining models and fields
- Setting up security and access rights
- Creating views and actions
- Implementing relational fields (many2one, many2many, one2many)
- Working with computed and related fields
- Adding business logic through server actions and automation rules
- Creating website controllers for API endpoints

The tutorial includes practical exercises and code examples to reinforce
learning, catering to developers who need to customize Odoo without writing
Python code (e.g. Odoo PS-Tech employees, partners that focus on SaaS instances
or author of Industry modules).

Task-4167176

closes odoo/documentation#11050

Signed-off-by: Bouvy Damien (dbo) <dbo@odoo.com>
2024-10-31 17:15:21 +00:00
Nguyen Minh Tran Manh Cuong
d77c24d556 [FIX] tutorials/server_framework_101: position of form's notebook element
The notebook element should be nested in the sheet element.

closes odoo/documentation#9744

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-06-10 10:06:02 +00:00
Alice Gaudon
15c6bb8b0e [IMP] tutorials: add example code for LazyComponent
js framework/Build a Dashboard/part 8 (LazyComponent)

There is no explicit instructions on how to use `LazyComponent`.

- add an example code snippet for minimal use of `LazyComponent`
- add the `.js` extension to the file you're supposed to create to make it a bit more intuitive
- fix `actions` registry name (missing an s)
- reword instructions in a more straightforward way

closes odoo/documentation#9521

Signed-off-by: Florent Dardenne (dafl) <dafl@odoo.com>
2024-05-31 17:12:23 +00:00
XPL
e6d312f18d [IMP] settings: simplify the developer mode page
task-3849915

closes odoo/documentation#9235

X-original-commit: e16a66706a
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-05-07 23:12:12 +00:00
Victor Feyens
b8e0e40722 [FIX] dev/tutorials: typo
courtesy of @/ChloeLiang

closes odoo/documentation#9048

X-original-commit: 3e62a8c4cd
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-04-29 12:14:07 +00:00
Antoine Vandevenne (anv)
7f623b6ad5 [IMP] developer: improve navigation in top-level pages
Prior to this commit, users had to either know in advance or guess the
location of the content they were looking for. Top-level pages of the
"Developer" section of the documentation, in particular the "Developer"
page itself, were listing their sub-pages without directions for users.

This commit brings the following changes to improve the navigation:
- add directions for users on the "Developer" page and list the three
  main categories of developer documentation ("Tutorials", "How-to
  guides", and "Reference") with explanations of their content and
  target audience;
- add categories for content cards on the "Tutorials" and "How-to
  guides" pages, and fine-tune the toctree of the "Reference" page to
  more easily locate specific topics;
- clarify what are the "Python framework" and the "JavaScript framework"
  by relabelling them to "Server framework" and "Web framework" on
  top-level pages, as some users were confused to find that the JS
  framework was not responsible for the server, and others that the
  documentation for QWeb template is located in the Python documentation;
- extract the "Setup guide" from the "Getting started" tutorial and
  rename the latter to "Server framework 101" to allow reusing the setup
  guide in other tutorials and make clear that the "Server framework 101"
  tutorial is not about the Web framework.

task-3802536

closes odoo/documentation#8597

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
2024-04-12 09:53:17 +00:00
Antoine Vandevenne (anv)
632add350d [FIX] tutorials/discover_js_framework: clarify instructions
closes odoo/documentation#8065

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-03-15 17:29:49 +00:00
Jonathan Castillo (jcs)
10cd2a061b [MOV] documentation structure reorganization
This commit aims to improve the documentation's navigability by
redefining some categories' purposes and titles.

There is a redirection rule for each documentation page moved.
This ensures that users won't have a 404 error message.

task-3217827

closes odoo/documentation#8061

Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-03-11 15:03:04 +00:00
Claire Bretton (clbr)
a54e626075 [IMP] getting_started: use odoo/tutorials repository + runbot
We now use the odoo/tutorials to make the technical onboarding.
- Change the current documentation accordingly.
- Add a section for employees only so that they use odoo-dev/tutorials
as shared fork. It's closer to our way to work so we think it's better
to make them use to it as fast as possible.
- Add some explanations about runbot.

`odoo/technical-training-sandbox` will no longer be used and can be considered deprecated.

closes odoo/documentation#8041

X-original-commit: e60affa6fe
Signed-off-by: Claire Bretton (clbr) <clbr@odoo.com>
2024-03-06 12:46:16 +00:00
Tarek berkane
dc3bdd3824 [FW][FIX] tutorials/getting_started: typo in 'estate'
closes odoo/documentation#7782

Forward-port-of: odoo/documentation#7772
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-02-19 17:53:16 +00:00
Antoine Vandevenne (anv)
439c4521ad [IMP] reference/user_interface: reformat and clarify views reference
In particular, the following changes are made:
- Use the `class` and `attribute` admonitions along with custom
  attributes to define classes, views' root attributes, views'
  components, and attribute values. This allows re-using the responsive
  design that was made for reference lists, and getting rid of the
  previous implementation that relied on class attributes, which were not
  intended for this usage and reduce readability while hindering further
  contributions due to a lack of flexibility (no admonitions,
  sub-attributes...)
- Use definition lists to define view types to allow for clearer and
  longer descriptions.
- Rewrite and restructure the explanations when there is a lack clarity.
- Extract duplicated content to included RST files.
- Display SVG images into dedicated admonitions.
- Fix RST and English mistakes.
- Rename `view_architecture` to `view_architectures`, as it lists all
  existing architectures and doesn't describe "the architecture of a
  view".
- Replace underscores with hyphens in image file names to improve SEO.

task-3458320

closes odoo/documentation#5237

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-01-19 15:21:43 +00:00
YStorm5
f62c7f83c5 [FIX] developer/tutorials/getting_started: swap headers
I think these two header got mix up.

closes odoo/documentation#7199

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-01-03 09:17:54 +00:00
Géry Debongnie
3d4a275196 [IMP] Rework the JavaScript tutorials
This commit rework the entire JavaScript tutorial series with the
following improvements:

-   Each chapter is now designed to be independent, allowing learners to
    follow any chapter without the necessity of completing previous ones.
-   Each chapter has been transformed into a standalone module, enabling
    learners to create small projects from scratch within each chapter.
-   The screenshots/text/code have been updated for Odoo 17.

Currently we have 5 chapters:
- Discover Chapter 1 - Owl Components: This chapter allows to learn the
  Owl framework in the `awesome_owl` module.
- Discover Chapter 2 - Build a dashboard: This chapter allows to grasp
  the basic of the web framework by building a dashboard in the
  `awesome_dashboard` module.
- Master Chapter 1 - Build a clicker game: This chapter allows to grasp
  the web framework by building a clicker game in the `awesome_clicker`
  module.
- Master Chapter 2 - Create a gallery view: This chapter allows to learn
  how to create a new view type. The new view is a gallery of records
  pictures. It can be done in the `awesome_gallery` module.
- Master Chapter 3 - Customize a kanban view: This chapter allows to
  learn to customize a kanban view by implementing a list of customer in
  the side of a kanban view. This can be done in the `awesome_kanban`
  module.

The chapter on creating and customizing fields is deleted for now and
will be completely rewritten in a near future.
The chapter on testing is deleted, how-to guides will be written to
cover this subject.

The solutions for all exercises has been done for v17, the goal by
merging the new tutorial is to have this new branch structure in
`odoo/tutorials`:
- 16.0
- 16.0-solutions
- 17.0
- 17.0-discover-js-framework-solutions
- 17.0-master-odoo-web-framework-solutions
-   master <-- default branch, starting point for all addons
-   master-discover-js-framework-solutions
-   master-master-odoo-web-framework-solutions

closes odoo/documentation#6876

Task-id: 3623595
Signed-off-by: Géry Debongnie <ged@odoo.com>
2023-12-18 23:31:55 +00:00
Claire Bretton (clbr)
32517aa638 [FIX] getting_started: remove useless lambda
The lambda function here is useless and makes newdooers think
they need to use it everytime.
`default=fields.Date.add(fields.Date.today(), months=3))`
should do the trick, no lambda involved.

closes odoo/documentation#6631

X-original-commit: 620508fb29
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Claire Bretton (clbr) <clbr@odoo.com>
2023-11-24 06:53:31 +00:00
Claire Bretton (clbr)
e8106a55c4 [FIX] getting_started: invalid addons-path
The "../technical-training-sandbox" is added too early in the path since
its still empty, and results into an "invalid addons-path" error.

X-original-commit: 8707609b38
Part-of: odoo/documentation#6631
2023-11-24 06:53:31 +00:00
dispread
1a26e5ae52 [FW][FIX] developer/tutorials: wrong kanban view example
Pretty sure the previous wasnt the intended result as it would show the "this is new" in a new kanban card. This just groups it with the property it belongs to.

closes odoo/documentation#5907

Forward-port-of: odoo/documentation#5899
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-09-25 13:09:11 +00:00
Odoo's Mergebot
1c072f0ac2 [FW][FIX] developer/tutorials/discover_js_framework: fix broken "domain.js" link
The link pointing to domain.js file was broken.
The xml id on the line before that is also broken but it will be fixed with PR#5699.

closes odoo/documentation#5709

Forward-port-of: odoo/documentation#5702
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Armin FalDiS <armin.fallah96@gmail.com>
Co-authored-by: Armin FalDiS <fara@odoo.com>
2023-09-04 09:19:17 +00:00
Andrea Tasselli
2f9645c1a6 [FW][FIX] developer/tutorials/discover_js_framework: add missing this
closes odoo/documentation#5687

Forward-port-of: odoo/documentation#5677
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-08-31 06:16:02 +00:00
Xavier (XPL)
692fe78bd1 [FIX] install: fix reference and redirect
closes odoo/documentation#5552

X-original-commit: 2b9ffdb240
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2023-08-19 21:05:40 +02:00
Xavier (XPL)
ea53f06197 [REF] install: move intro to main install page and split by install type
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

closes odoo/documentation#5543

X-original-commit: 91c28fd433
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2023-08-19 07:58:45 +02:00
Gorash
83c2012f95 [IMP] reference: rewrite and move views documentation to user_interface/
The documentation of the views is redone in order to be up to date and
has allowed a better visualization of the task on the modifiers.

task-2495504

closes odoo/documentation#3523

Related: odoo/odoo#104741
Related: odoo/enterprise#35255
Related: odoo/upgrade#4884
Signed-off-by: Julien Castiaux (juc) <juc@odoo.com>
2023-08-18 09:49:36 +02:00
Antoine Vandevenne (anv)
0e97376921 [FIX] tutorials/getting_started: fix typos in example model name
Commit f36c612d13 changed the model name
in Chapter 4 without updating the other occurences.

closes odoo/documentation#5516

X-original-commit: b6f923d111
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-08-17 18:43:18 +02:00
Samuel Degueldre
eb63fd7629 [IMP] remove references to owl template tagging
In odoo/odoo#130467 the necessity to tag owl templates with an owl="1"
attribute has been removed, update the docs to reflect that.

closes odoo/documentation#5460

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-08-11 19:34:53 +02:00
Levi Siuzdak (sile)
dd7ab18b9e [IMP] developer: add notes on entity references & fix illegal XML
Using `<` inside XML elements will result in a parsing error,
an entity reference should be used instead: `&lt;`.

closes odoo/documentation#5184

X-original-commit: a7743d513b
Signed-off-by: Levi Siuzdak (sile) <sile@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-07-24 23:04:05 +02:00
chyde-clearwater
3758cd5899 [IMP] tutorials/getting_started: disambiguate example model name
I removed the dot notation in the  "_name" variable for the example
model. AKA, "test.model" is now named "test_model".

Dot notation implies a data structure relationship between a <model> and
it's parent (or class etc) <test> (like test.model() or Test.model).
There is no relationship like this between a <test> and <model> - it's
just one thing: a <test model>.

The seeming "benefit" of the ORM translating dots to underscores doesn't
justify this naming convention.  Yes, I know it's a string, but still,
this seems confusing for newbies and adds unnecessary complexity (why
name the same thing differently in different places?)

closes odoo/documentation#5141

X-original-commit: f36c612d13
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-07-18 13:07:47 +02:00
Benoit Socias
0df9068892 [FIX] howto/rdtraining: ch.13 adapt reference to salesperson field
In chapter 13 the `property_ids` field is defined as the inverse of a
`user_id` field. But in chapter 8 when the salesperson field is added,
no such name is given to it.

This commit adapts the description to reference the general concept of
the field used to link to the salesperson instead of an actual field
identifier.

task-3381757

closes odoo/documentation#4913

X-original-commit: 3a131c829a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-06-27 13:44:38 +02:00
Antoine Vandevenne (anv)
fd933208d3 [IMP] tutorials/getting_started: rework the environment setup guide
This commit replaces a big chunk of the instructions relative to the
environment setup with a reference to the equivalent steps listed in the
contribution guide. It also moves the content of the "Create your first
PR" section from chapter 16 to chapter 2, as readers were struggling
with the Git configuration required to push their work to GitHub as they
progressed through the tutorial.

closes odoo/documentation#4413

X-original-commit: 26e12696c1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-05-11 18:25:41 +02:00
Antoine Vandevenne (anv)
8c29d1fd6a [FIX] reference/services: mark optional the params parameter of rpc
closes odoo/documentation#4282

X-original-commit: c1b38dc1f3
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-27 18:25:21 +02:00
Antoine Vandevenne (anv)
b1a76aec63 [IMP] tutorials/js_framework: reword, clarify and improve instructions
X-original-commit: b58dbb1fbb
Part-of: odoo/documentation#4282
2023-04-27 18:25:21 +02:00
Antoine Vandevenne (anv)
08f472ef28 [IMP] tutorials/js_framework: freeze GitHub links with line numbers
A few links were already outdated. Either the referenced code was no
longer on the same line, or the file didn't exist anymore.

This commit freezes all links targeting a specific line on the odoo/odoo
repository by selecting a specific commit.

X-original-commit: 6e746c851f
Part-of: odoo/documentation#4282
2023-04-27 18:25:20 +02:00
Antoine Vandevenne (anv)
d90e09c8b7 [IMP] tutorials/js_framework: retarget links to the current major branch
Commits pushed on the odoo/tutorials repository are not automatically
forward-ported, which makes it cumbersome to keep all SaaS branches up
to date.

Because of this, and because Odoo developers are very unlikely to follow
tutorials specific to a SaaS branch, links to odoo/tutorials now target
the current major branch, or master if applicable. SaaS branches have
also been deleted from the odoo/tutorials repository.

X-original-commit: ce14b2cfb5
Part-of: odoo/documentation#4282
2023-04-27 18:25:20 +02:00
Géry Debongnie
adb845eb17 [IMP] developer/tutorials: separate js framework tutorial in two parts
This commit splits the 7 chapters of the JS tutorial in two
smaller and more focused tutorials:
- a basic one (Discover the JS framework)
- and an advanced one (Master the odoo web framework)

closes odoo/documentation#4248

X-original-commit: b6b9de70d2
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-25 11:22:48 +02:00
wangting
9fb8c5c354 [FIX] tutorials/js_framework: fix typo
closes odoo/documentation#4148

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-13 16:40:41 +02:00
Tiffany Chang (tic)
e18b24a176 [REM] developer: remove references to web_dashboard view
Since odoo/enterprise#31641 the dashboard view no longer exists since it
is now replaced with spreadsheet_dashboard, therefore we remove it from
the backend Views documentation.

Task: 3226581
X-original-commit: e2c880aafe
Part-of: odoo/documentation#4035
2023-04-05 17:31:58 +02:00
Benoit Socias
39d5455110 [IMP] tutorials: add warning about mutable global variables
The whole concept of multi-tenancy is not really approached within the
tutorial.

This commit adds a warning about never using mutable global variables
within odoo to seed the idea in the reader's mind.

task-3059110

closes odoo/documentation#3991

X-original-commit: 1ce7166f49
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Benoit Socias (bso) <bso@odoo.com>
2023-04-03 13:55:23 +02:00
Jonathan Castillo (jcs)
33f99d03dc [FIX] dev/tuto: grammar mistake in 02_setup
task-3238089

closes odoo/documentation#3849

X-original-commit: 6866cfa361
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-03-20 16:51:47 +01:00
Antoine Vandevenne (anv)
518db8b02a [MOV] developer/api/external_api: move "External API" to the reference dir
task-2991663

X-original-commit: 95ed856446
Part-of: odoo/documentation#3660
2023-02-23 16:09:00 +01:00
Antoine Vandevenne (anv)
ba7a47e03e [IMP] tutorials/*: hide outdated tutorials
*: backend, web, website

task-2991663

X-original-commit: 9561c9abf8
Part-of: odoo/documentation#3660
2023-02-23 16:08:59 +01:00
Antoine Vandevenne (anv)
d783dd375a [MOV] howto/web: move "Customizing the webclient" to the tutorials dir
task-2991663

X-original-commit: 2d469bccbc
Part-of: odoo/documentation#3660
2023-02-23 16:08:59 +01:00
Antoine Vandevenne (anv)
c2d7f03b8b [MOV] howto/website: move "Building a website" to the tutorials dir
task-2991663

X-original-commit: 58f2174c49
Part-of: odoo/documentation#3660
2023-02-23 16:08:59 +01:00
Antoine Vandevenne (anv)
1292abc9e7 [MOV] howtos/backend: move "Building a module" to the tutorials dir
task-2991663

X-original-commit: 642c4839f7
Part-of: odoo/documentation#3660
2023-02-23 16:08:58 +01:00
Antoine Vandevenne (anv)
899960a66d [MOV] howtos/discover_js_framework/*: move "Discover the JS Framework" to the tutorials dir
task-2991663

X-original-commit: 9c5ea316ff
Part-of: odoo/documentation#3660
2023-02-23 16:08:58 +01:00
Antoine Vandevenne (anv)
c3a66c28a0 [MOV] tutorials/getting_started/*: promote advanced chapters to independent tutorials
task-2991663

X-original-commit: a8c78a80ba
Part-of: odoo/documentation#3660
2023-02-23 16:08:58 +01:00
Antoine Vandevenne (anv)
018d708b44 [MOV] howto/rdtraining: move "Getting started" to the tutorials dir
This commit also replaces references to the "Building a module"
tutorial by references to the "Getting started" tutorial.

task-2991663

X-original-commit: 4f4e346953
Part-of: odoo/documentation#3660
2023-02-23 16:08:58 +01:00