Added the new `i18n` and `module` commands.
Added the existing `deploy`, `obfuscate`, `upgrade_code` commands.
Reviewed titles to make the commands stand out in the ToC.
Removed the no longer present `tsconfig` command.
task-4866527
closesodoo/documentation#14368
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Odoo is transitioning away from Transifex. Remove links/references to it
and replace with new platform (internal Weblate server) links
closesodoo/documentation#14163
X-original-commit: 78de46cb0f
Signed-off-by: Tiffany Chang (tic) <tic@odoo.com>
Url path to access server action updated from /actions to /website/action
Added xml record that Javascript tour was missing to work properly
closesodoo/documentation#13283
X-original-commit: 4efa5133d6
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: François Vasamillet (frva) <frva@odoo.com>
When readers follow the server framework 101 tutorial, it's common for them
to set the model access rights the same as in the tutorial's example at
chapter 4. Following this example they will have read only permissions and
by chapter 6 they will not be able to create/update or delete objects in
order to follow with the tutorial.
This commit adds a warning for readers to remind them of the relation between
the access rights set previously and what they can see and do using the UI.
closesodoo/documentation#12289
X-original-commit: 14de18996e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
External contributors (and namely Odoo PS) forget to set the author
field in their manifest file. The result is that the module is wrongly
registered with `'author': 'Odoo S.A.'`.
This work makes the field mandatory, with a warning when not set. It
also offers an upgrade-code script to mass-rewrite all the manifests in
order to set the author.
task-4485983
closesodoo/documentation#11956
Related: odoo/odoo#196408
Related: odoo/enterprise#78513
Related: odoo/design-themes#1044
Signed-off-by: Julien Castiaux (juc) <juc@odoo.com>
previous link was for code that used tree in xml. The tree tag throws Traceback error in 18.0. This commit will provide the correct example with list tag instead of tree tag.
closesodoo/documentation#11867
Forward-port-of: odoo/documentation#11865
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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.
closesodoo/documentation#11489
X-original-commit: d77d3ace2a
Signed-off-by: Vallaeys Valentin (vava) <vava@odoo.com>
On line 60 changed "we will can print..." to "we will be able to print..."
closesodoo/documentation#11366
X-original-commit: ad624afdf8
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
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
closesodoo/documentation#11305
X-original-commit: c6a8619367
Signed-off-by: Bouvy Damien (dbo) <dbo@odoo.com>
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
closesodoo/documentation#9596
X-original-commit: 15c6bb8b0e
Signed-off-by: Florent Dardenne (dafl) <dafl@odoo.com>
Signed-off-by: Alice Gaudon (agau) <agau@odoo.com>
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
closesodoo/documentation#8712
X-original-commit: 7f623b6ad5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
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
closesodoo/documentation#8064
Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
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.
closesodoo/documentation#8043
X-original-commit: e60affa6fe
Signed-off-by: Claire Bretton (clbr) <clbr@odoo.com>
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
closesodoo/documentation#5237closesodoo/documentation#7497
X-original-commit: a17eaf4c6f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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
closesodoo/documentation#6980
Task-id: 3623595
X-original-commit: 3d4a275196
Signed-off-by: Géry Debongnie <ged@odoo.com>
Signed-off-by: Florent Dardenne (dafl) <dafl@odoo.com>
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.
closesodoo/documentation#6632
X-original-commit: 620508fb29
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Claire Bretton (clbr) <clbr@odoo.com>
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#6632
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.
closesodoo/documentation#5907
Forward-port-of: odoo/documentation#5899
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
