57b7ca69d9
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#8712
X-original-commit: 7f623b6ad5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
86 lines
2.6 KiB
ReStructuredText
86 lines
2.6 KiB
ReStructuredText
:show-content:
|
|
:hide-page-toc:
|
|
|
|
=========
|
|
Tutorials
|
|
=========
|
|
|
|
.. toctree::
|
|
tutorials/setup_guide
|
|
tutorials/server_framework_101
|
|
tutorials/discover_js_framework
|
|
tutorials/master_odoo_web_framework
|
|
tutorials/define_module_data
|
|
tutorials/restrict_data_access
|
|
tutorials/unit_tests
|
|
tutorials/mixins
|
|
tutorials/pdf_reports
|
|
|
|
.. tip::
|
|
If you are new to Odoo development, we recommend starting with the :doc:`setup guide
|
|
<tutorials/setup_guide>`.
|
|
|
|
Learn the server and web frameworks
|
|
===================================
|
|
|
|
.. cards::
|
|
|
|
.. card:: Server framework 101
|
|
:target: tutorials/server_framework_101
|
|
:tag: Beginner
|
|
:large:
|
|
|
|
This introductory tutorial is designed for complete beginners seeking to get started in Odoo
|
|
development. It covers the essential aspects and key concepts of the server framework. Learn
|
|
to create a simple module from scratch with step-by-step instructions and practical insights.
|
|
|
|
.. card:: Discover the web framework
|
|
:target: tutorials/discover_js_framework
|
|
:tag: Beginner
|
|
|
|
This tutorial will teach the basics of the web framework and how to work with Owl components
|
|
by customizing the web client.
|
|
|
|
.. card:: Master the web framework
|
|
:target: tutorials/master_odoo_web_framework
|
|
:tag: Advanced
|
|
|
|
Become an expert in the web framework. A large variety of features are covered such as fields,
|
|
views, and even the kitten mode.
|
|
|
|
Expand your knowledge on the server framework
|
|
=============================================
|
|
|
|
.. cards::
|
|
|
|
.. card:: Define module data
|
|
:target: tutorials/define_module_data
|
|
:tag: Beginner
|
|
|
|
Define master and demo data for an Odoo module, leveraging the strengths of the CSV and XML
|
|
file formats to accommodate specific data requirements.
|
|
|
|
.. card:: Restrict access to data
|
|
:target: tutorials/restrict_data_access
|
|
:tag: Beginner
|
|
|
|
Implement security measures to restrict access to sensitive data with the help of groups,
|
|
access rights, and record rules.
|
|
|
|
.. card:: Safeguard your code with unit tests
|
|
:target: tutorials/unit_tests
|
|
:tag: Beginner
|
|
|
|
Write effective unit tests in Python to ensure the resilience of your code and safeguard it
|
|
against unexpected behaviors and regressions.
|
|
|
|
.. card:: Reuse code with mixins
|
|
:target: tutorials/mixins
|
|
|
|
Create mixins to code features once and reuse them in multiple models.
|
|
|
|
.. card:: Build PDF reports
|
|
:target: tutorials/pdf_reports
|
|
|
|
Use QWeb, Odoo's powerful templating engine, to create custom PDF reports for your documents.
|