- Correction of a wrong file reference
- Correction of a wrong fille name
closesodoo/documentation#13393
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit improves current Odoo version information on the theming
page, by adding better contextual content.
Task-4316619
closesodoo/documentation#12952
Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com>
This commit updates current media page, by adding updated content.
Task-4316619
closesodoo/documentation#12578
Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com>
This commit updates current theming page, by adding updated content.
Task-4316619
closesodoo/documentation#12577
Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com>
This commit updates current navigation page, by adding updated
information.
Task-4316619
closesodoo/documentation#12579
Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com>
Rework of the whole page in order to organized / categorized the content better + Addition from the PSBE Designers Wiki
[FIX] Website Themes - Building block : Fix typo
[FIX] Corrections after review
closesodoo/documentation#12474
X-original-commit: 1ef929990c
Signed-off-by: Brandon Mercier (bram) <bram@odoo.com>
This commit adds the `media` page, links it to the `website_themes`
index, deletes duplicated content from the `pages.rst` page and moves
images from the current `pages` folder to a new one.
Task-4316611
closesodoo/documentation#12465
X-original-commit: 0044a6bb09
Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com>
This commit updates current `shapes` page, by adding new anchor links
to the sections, updated information and images.
Task-4316611
closesodoo/documentation#12432
X-original-commit: 4e0f298786
Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com>
This commit updates current `animations` page, by adding new anchor
links to the sections, updated information and images.
Task-4316611
closesodoo/documentation#12431
X-original-commit: 0ea5823a94
Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com>
This commit updates current navigation page, by adding new anchor links
to the sections and by adding updated information.
Task-4316611
closesodoo/documentation#12434
X-original-commit: a548d85da8
Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com>
This commit updates current `translations` page, by adding new anchor
links to the sections, updated information and images.
Task-431661
closesodoo/documentation#12344
X-original-commit: e508d96c1d
Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com>
This commit updates current theming page, by adding new anchor links to
the sections and by adding updated information.
Task-4316611
closesodoo/documentation#12275
X-original-commit: 16e1bad7db
Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com>
A typo was found. The word "customeKanbanView" is misspelled and should be "customKanbanView", which is the constant exported correctly in the code. Therefore, the corrected line would be:
closesodoo/documentation#9661
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
* Add autodoc directives to generate documentation directly from
upgrade-util repo.
* Group all upgrades-related reference documentation into one group in
the sidebar, instead of having two entries.
* Mention `upgrades` vs `migrations` directory. It has been supported
since a while but nothing was explicit in the documentation.
Original commit: 91a48bfe88closesodoo/documentation#8836
Signed-off-by: Victor Feyens (vfe) <vfe@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#8597
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#8061
Signed-off-by: Jonathan Castillo (jcs) <jcs@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#5237
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#6876
Task-id: 3623595
Signed-off-by: Géry Debongnie <ged@odoo.com>
When writing the documentation page for standalone Owl apps, it was
originally required to create the env and start the services manually,
and then mount the application by giving it a bunch of configuration
parameters. During review, it was noted that this was error prone and
confusing, and as such a corresponding PR added a helper to mount the
application without needing to do much by hand. While the code was
adapted in the documentation that was merged, the text still referred to
starting the services and creating the environment which is no longer
necessary.
This commit removes references to those things, and because the
resulting section is very small and not very interesting it has been
merged into the previous section.
closesodoo/documentation#6669
Signed-off-by: Samuel Degueldre (sad) <sad@odoo.com>
Since we've introduced Owl, developers want more and more to create
standalone Owl applications outside of the webclient. This commit
introduces a How-to for doing just that.
task-3580007
closesodoo/documentation#6493
Related: odoo/odoo#142498
Signed-off-by: Samuel Degueldre (sad) <sad@odoo.com>
It has been decided to remove the possibility for our users to create
their own IAP services.
This decision was motivated by the fact that, in the 5 years of
existence of IAP, very few non-Odoo services have been created and
actively used by our customers.
X-original-commit: 282f041ed1
Part-of: odoo/documentation#6327
Remove parenthesis around a term that's fairly straightforward to
understand and later used as a title Add a much-needed point.
closesodoo/documentation#6126
X-original-commit: 6f3ed657fc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Stanislas Gueniffey (stgu) <stgu@odoo.com>
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
closesodoo/documentation#5543
X-original-commit: 91c28fd433
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
In odoo/odoo#130467 the necessity to tag owl templates with an owl="1"
attribute has been removed, update the docs to reflect that.
closesodoo/documentation#5460
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
This commit improves the structure of the accounting documentation by
- reducing the levels necessary to reach the information
- grouping some docs
- moving content to their parent category page (content in all levels)
- renaming some sections to reflect the structure of the app better
task-3330093
closesodoo/documentation#4479
X-original-commit: c68cc154ed
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
A complete guide on how to create a custom website theme for Odoo
closesodoo/documentation#4420
X-original-commit: 892fd3e2ac
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
