The documentation of view attributes was lacking visual structure to
help the reader figure out which attribute relates to which parent
element. Since this documentation was relying on RST block quotes to
represent the hierarchy of view attributes, we can apply the same new
styling that was added with commit 934f45cf and designed for autodoc,
and which relies on the exact same HTML structure as block quotes.
task-2755298
closesodoo/documentation#2342
X-original-commit: e2a3ca0631
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
In chapter 3 of the developer core training, one is asked to click on a
button that is only shown in debug mode but there is no indication about
this mode in this chapter.
closesodoo/documentation#2304
X-original-commit: 96d822bf87
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The `redirects.txt` file used to specify redirect rules for renamed or
moved documentation pages is starting to grow too big to be easily
maintainable. The main reason is that the number of redirect rules that
were thought to be required has been largely underestimated when
implementing the 'redirects' extension. At first, we believed that no
guidelines or structure were necessary because only a small amount of
redirect rules would be specified. This proved wrong and the file is now
becoming a mess, making it increasingly difficult to figure out where,
why, when, and if a redirect rule is specified in the file.
As the file is versioned, another issue emerges: conflicts occur every
time a commit is forward-ported to a later version if that commit adds a
redirect rule at the end of the file or at a line that was changed in
the later version. As redirect rules are frequently added, and since
blocks of redirect rules for new versions are added at the end of the
file, this tends to happen a lot.
This commit attempts to hit two birds with one stone by splitting the
`redirects.txt` file into multiple files, one per version. While doing
so, the existing redirect rules are ordered alphabetically and moved
into contextual blocks. Instructions and guidelines on how to create
redirect rules are also listed in the `redirects/MANUAL.md` file. By
sorting the redirect rules and adding them in different files, the
number of conflicts should decrease by a lot.
task-2891912
closesodoo/documentation#2292
X-original-commit: 0417b95514
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
SHA1 is going to be deprecated by ogone.
This change try to keep current behaviour while adding the
possibility to use SHA256 and SHA512 via a Selection field
available in the developper mode.
Related to :
- odoo/upgrade#3490
- odoo/odoo#88628
opw-2766648
closesodoo/documentation#1902
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Deleting the Odoo Tutorials Invoices link since the course has been merged, and the link isn't necessary anymore.
closesodoo/documentation#2250
Forward-port-of: odoo/documentation#2243
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Because of a recent Chrome security update, a lot of customers using peripheral devices (printers, ...) will have to follow this doc.
Therefore, I followed the doc and did the flow on my side.
I modified 'Copy to file' to 'Export' and 'Trusted Root Certification Authorities' to 'Authorities' in order to have the exact same terms as in Chrome (I guess they updated their terms at some point).
closesodoo/documentation#2237
X-original-commit: 4c4b81b12c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
It is never shown to the trainee that he can install/update a module
right from the CLI. Multiple developpers still use the app manager to
install/update their modules multiple months into the job.
closesodoo/documentation#2189
X-original-commit: 3d2f067e6c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Julien Castiaux <juc@odoo.com>
it will also be renamed to .repositories in the near future
closesodoo/documentation#2166
X-original-commit: 1afee9e2c7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Added a note to specify that bank synchronization is not available on trial databases
closesodoo/documentation#2138
X-original-commit: e4fc5f07ee
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
Add 'x' to make evident that Authorize.net supports refunds directly
from odoo.
Task - 2712287
Task (on payment) - 2678757
closesodoo/documentation#2091
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Odoo is compatible with X-Sendfile (apache) and X-Accel (nginx). They
are web server extension that can be used by the web application (Odoo)
to delegate serving local files to the web server (apache/nginx). We use
those extension to stream attachments. The documentation now explains
what is X-Sendfile/X-Accel and how to configure each web server.
Along those changes, the few sentences about serving static files have
been reworded and now include various configuration examples.
closesodoo/documentation#2083
Task: 2801675
Related: odoo/odoo#88134
Related: odoo/enterprise#26191
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Starting July 2022, Amazon WMS API is deprecated and we need to use the Selling Partners API.
This brings changes in the authentication flow that are explained.
task-2466636
closesodoo/documentation#2107
X-original-commit: 2dd3a4ae74
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Add a check to indicate that Stripe supports refunds.
closesodoo/documentation#2086
Related: odoo/odoo#92235
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The previous file name was not very relevant in regard to the content of
the page, and it conflicted with the `sys.path`.
closesodoo/documentation#2068
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Since odoo/documentation#903, the guideline for the location of new
resource (images, downloadable files, RST includes...) files is to place
those inside the directory of the RST page that references them.
For example, if `doc1.rst` has a reference to `image.png` and to
`download.zip`, the file structure should look like this:
├── parent_doc/
│ └── doc1/
│ │ └── image.png
│ │ └── download.zip
│ └── doc1.rst
│ └── doc2.rst
├── parent_doc.rst
Before this commit, most of the resource files were still located inside
'media' directories holding all the resource files referenced by RST
pages located at the same level as these directories. In the example
above, a single 'media' directory would hold all the resource files
referenced by both `doc1.rst` and `doc2.rst`. Doing so prevented us from
figuring out easily which resource file was referenced by which RST page
and, thus, lead to unused resource files piling up in the repository. It
also made it more complicated to define codeowners regex rules because a
team could not simply be assigned to `/some_page.*` but needed to be
assigned to both `/some_page\.rst` and to the location of 'media'.
In order to help new content writers figure out the guideline when
taking examples from other RST pages, this commit retroactively applies
the guideline to existing resource files and 'media' directories. The
left-over resource files that are not referenced by any RST page are
removed.
task-2497965
Part-of: odoo/documentation#2068
Only `no_create` is required to hide both the 'Create "xxx"' and the
'Create and Edit...' dropdown menu options.
closesodoo/documentation#2016
X-original-commit: 599a137ffc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
closesodoo/documentation#1969
X-original-commit: 9db567159d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: William André (wan) <wan@odoo.com>
Co-authored-by: William Andre <wan@odoo.com>
Co-authored-by: Ivan Yelizariev <iel@odoo.com>
In case of an unsupported carrier or a self Delivery, Odoo won't block
the user to use the Amazon connector, but explanation were needed for
these cases.
task-2804907
closesodoo/documentation#1967
X-original-commit: 3231d20d92
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Since odoo/odoo#87522, the method fields_view_get is deprecated and
get_view should be used instead.
A deprecation notice will be included in fields_view_get docstring
to make sure users are aware that they shouldn't use it anymore.
closesodoo/documentation#1908
Related: odoo/odoo#90634
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
The previous guidelines for titles and headings included an exception to
capitalize feature names as they are written in the apps. However, this
exception seems to have confused most writers as it isn't always clear
what should be considered as a feature name or what should be considered
as a noun or noun group. This commit removes this exception to make the
writing and reviewing processes easier while retaining good titles and
improving consistency across the documentation. It also changes the
titles of the Accounting section to provide a better example to other
writers.
task-id 2843109
closesodoo/documentation#1922
X-original-commit: 1997788e81
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Mexican companies very commonly issue invoices in USD, to be fulfiled
in MXN, at the official exchange rate defined by the Banco de Mexico
on the day of payment.
(Presumably, this is to insure against the volatility of the Mexican
peso.)
Odoo supports this workflow, but only if the payment is registered
directly on the invoice using the 'Register Payment' button.
If the payment is created separately, and then reconciled manually
with the invoice, a whole host of problems occur:
- the payment typically can't be reconciled fully with the invoice,
(even though that can usually be solved by manually creating
an exchange move)
- but more problematically, the amounts on the payment CFDI will
be wrong, and even manually creating an exchange move won't solve
that.
So, we absolutely need to warn users not to try to do that.
(We've been encountering lots of tickets lately in the tech-support
pipe because of users who tried this and then wonder why it doesn't
work.)
This is currently an issue in 14.0, 15.0 and master.
closesodoo/documentation#1917
Forward-port-of: odoo/documentation#1728
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Changed commands that were still referring to Odoo 14.0 to 15.0
closesodoo/documentation#1880
X-original-commit: b578f575d0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The duplicate action is not available for list views
closesodoo/documentation#1860
X-original-commit: ce1961ebaf
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The duplicate action is not available for list views
closesodoo/documentation#1853
X-original-commit: 9cf425d886
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
After this PR: https://github.com/odoo/odoo/pull/78199
The explanation of the `Security Lead Time for Purchase` field needs to be updated
opw-2766940
closesodoo/documentation#1841
X-original-commit: 9c242400b6
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Djamel Touati (otd) <otd@odoo.com>
The "View Inheritance" section is introduced by a sentence that can be
understood as "do this task then we'll be ready to go the next section"
instead of "in the next section we will see how to do this task".
This can confuse the reader into thinking that some knowledge was not
acquired in the previous parts.
This commit makes it clear that the task described in the transition
sentence will be achieved in the next part.
task-2822582
closesodoo/documentation#1831
X-original-commit: 5a39ba7d24
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Benoit Socias (bso) <bso@odoo.com>
At the point when the developer mode is introduced in the training, it is
confusing because the documentation page describes the option inside the
Settings page, but that page only appears if at least one application is
installed. (Otherwise, the Settings app shows the Users instead)
This commit adds a note so that the reader does not start looking for a
screen that cannot be reached at that point.
task-2822582
X-original-commit: 2ebb7fe802
Part-of: odoo/documentation#1831
Since 11.0, the naming scheme changed from `(x.)saas~y` to `saas~x.y`.
closesodoo/documentation#1809
X-original-commit: 30f55dfd72
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
The destination location in manufacturing order shouldn't be a scrap location.
Otherwise, the user won't be able to complete manufacturing orders.
closesodoo/documentation#1794
X-original-commit: 7c5d18b84c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Codeowner regexes need images to be in the correct location, otherwise
some image files might not be assigned to a GitHub team when the regex
covering the parent folder is split into multiple codeowner rules.
closesodoo/documentation#1777
X-original-commit: 4e0a9b615f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The tags`add`, `remove` and `separator` are not included in the
documentation.
closesodoo/documentation#1741
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
Add documentation about the manual capture for Stripe
task-2781377
closesodoo/documentation#1642
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
In order for javascript translations to become active, the corresponding
addon needs to follow a certain naming scheme or register explicitly.
This commit updates the internationalization guide with a respective
hint.
Fixesodoo/documentation#1676closesodoo/documentation#1727
X-original-commit: 112b6c1267
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
All examples on the page suggest calling the CLI with "odoo-bin" while
it is recommended to call it with "odoo" when Odoo was installed from a
distribution package. It also failed to mention the location of
"odoo-bin" relative to the source files.
The chance is also taken to rename the somewhat unclear page title to
something more clear and generic.
closesodoo/documentation#1699
X-original-commit: c018a53686
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
In d46e358d3e88aea9f9289c4845c6c87ab9491c55 some mail.thread method
names were changed: it should be changed in documentation too.
closesodoo/documentation#1686
X-original-commit: b24560e224
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Add link to try the OCR service, cleanup copy.
closesodoo/documentation#1660
X-original-commit: b83df4f6d2
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
This commit adds the user documentation about the modification done in
the payment onboarding and the new Stripe Connect capabilities.
task-2685160
closesodoo/documentation#1631
X-original-commit: ff55b18aa2
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
Backport of commit d227ab66b0 on #1448closesodoo/documentation#1617
X-original-commit: a80f3c3899
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Introduce changelog of the ORM by version, link to first change documented
closesodoo/documentation#1508
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Recently, the API of useAutofocus has been simplified (see 4308de6aab).
Here we adapt its documentation.
closesodoo/documentation#1572
Signed-off-by: Mathieu Duckerts-Antoine <dam@odoo.com>
The current webinar link is for another version, with this commit we're adding the newest webinar link.
closesodoo/documentation#1569
X-original-commit: 45726dded7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
In many places in the docs, we need to document several flows that
differ only by a few details. For example, the steps to install Odoo
from the sources are almost identical for Windows, Linux, and Mac OS.
In other places, we'd want to suggest a command in different
environments or programming languages, etc.
This commit thus adds an extension for content tabs (tabs within the
content) to help reduce content repetition in the documentation. As a
proof of concept, the "Packaged installers" and "Source install"
sections of the "Installing Odoo" page are reworked to present their
content within tabs whenever it helps clarify the instructions.
A new python dependency is added as of this commit: `sphinx-tabs`
task-2713983
closesodoo/documentation#1528
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Lucie Van Nieuwenhuyse (luvn) <luvn@odoo.com>
Creation of a new submenu under Applications/General for the Email communication.
Moved advanced of dicuss to this new submenu + adding of content regarding
frequently asked question in support.
Redirection has been done on other files pointing to Discuss/Advanced to match
the new folder email_communication.
Modified content in:
- Email servers: split and move configuration part under email_domain
- Email domain: covering information about SPF DKIM and DMARC configurations by JQU
- Email templates: (how to use the functions) by GOR
- Email common: answering frequently asked questions + common issues by ALA
closesodoo/documentation#1550
X-original-commit: ce8a02d46a
Signed-off-by: Vergote Baptiste (bve) <bve@odoo.com>
Adding basic information about `How to make a test tour`.
task-2742841
closesodoo/documentation#1524
X-original-commit: dbd5a1e1bb
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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.
closesodoo/documentation#1515
X-original-commit: a9bc16bec8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
The "Payment Acquirers" category was moved to the /general/ folder
(Miscellaneous section) when the super-categories such as "Finance"
didn't exist yet. Now, it makes more sense to move this category to
"Finance".
task-id 2743227
X-original-commit: cbe6aad9e9
Part-of: odoo/documentation#1507
The "Enable IPN" step is also removed because this setting is overruled
by the payment request that Odoo sends to PayPal. Enabling IPN in PayPal
has no effect.
task-2744043
closesodoo/documentation#1489
X-original-commit: b97ca3f44d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Add payment methods supported by Odoo
This will inform users of Stripe which payment method we currently
support.
task-2685143
closesodoo/documentation#1483
X-original-commit: 587b2862df
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Valentin Chevalier <vcr@odoo.com>
This changed for Odoo 15.0 in odoo/odoo#61853 and the docs didn't
reflect that change.
MT-52 @moduon
closesodoo/documentation#1469
X-original-commit: 084fb777f9
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit adds the developer documentation for a
component recently added to the web_enterprise module.
It also includes examples and a screenshot used in the
documentation.
closesodoo/documentation#1432
X-original-commit: 7763c22db4
Signed-off-by: Géry Debongnie <ged@odoo.com>
Signed-off-by: Luca Vitali <luvi@odoo.com>
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
closesodoo/documentation#1364
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
The "qweb key of the manifest" file was still mentionned even if it has
been replaced by the assets bundles.
See related task: 2352566
closesodoo/documentation#1434
X-original-commit: dc832e1cc8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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)
closesodoo/documentation#1426
Forward-port-of: odoo/documentation#1350
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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/1118closesodoo/documentation#1424
X-original-commit: a692dbdc9c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The training suggests to put the views in the data/ folder instead of the views/ folder
closesodoo/documentation#1418
X-original-commit: 9d45b861c0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
- reset the `currentmodule` so the fields are not attributed to
`odoo.fields`, also prefix the field names (for a similar reason)
- expand `active` with the documentation of the related methods
closesodoo/documentation#1352
Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com>
* remove the documentation for `_auto`, `abstract`, and `_transient`
as that's redundant with `Model`
* add documentation for transients' dedicated attributes (and main
method whose docstring explains what actually occurs)
Part-of: odoo/documentation#1352
forward-port of e946f5fcfd
original commit (never merged) 427b14dcaeclosesodoo/documentation#1393
X-original-commit: 71fe1e09ee
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Requesting a dump from the customers comming from the PaaS is useless
(since support has access to the odoo.sh projects) and counter
productive (since it only makes the migration outage longer while the
customer downloads the file, then uploads it, then we download it,
instead of just the support downloading it)
closesodoo/documentation#1368
X-original-commit: c3c054681c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
and ease the way to get the api keys
task-2574512
closesodoo/documentation#1346
X-original-commit: 92ad3e8658
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
With the new version of chrome 95 we need adapt the documentation
closesodoo/documentation#1320
X-original-commit: 0f1f90e486
Signed-off-by: Quentin Lejeune (qle) <qle@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit applies some remarks by Antoine.
closesodoo/documentation#1328
X-original-commit: 8c1003e363
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit adds the documentation related to
the scroller service. This service is used for
the webclient to handle clicks on links and there
were no documentation related until now.
closesodoo/documentation#1326
X-original-commit: 1f84bab97d
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
New taxes generated by the TaxCloud integration are by default created without an income or an expense account specified. By default, the journal items corresponding to these taxes therefore end up in the default income account, which is usually the 'Sales' account, when they should in fact go to the 'Tax Payable' account. Because these taxes are automatically generated on-the-fly, the user is usually not able to manually specify the Tax Payable account before the journal items are posted, leading to incorrect accounting entries which then need to be manually repaired through the use of miscellaneous operations.
To solve this issue, our video on TaxCloud integration (https://www.youtube.com/watch?v=JE-NeRNIWeU&t=616s) tells us to create a User-Defined Default for the account field of the tax.repartition.line model. This sets the default account with which new taxes are created. However, this information is missing from the documentation.
This PR brings the documentation up-to-date by explaining how to create this User-Defined Default that specifies the correct Tax Payable account.
closesodoo/documentation#1322
X-original-commit: 35d773a82a
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
This will help users to get automatically images for their products.
task-2558054
closesodoo/documentation#1316
X-original-commit: e062a7c816
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Add documentation to explain how to use a ePos printer in HTTPS
closesodoo/documentation#1308
X-original-commit: f8f93ec288
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
and add entry for effects registry as well
closesodoo/documentation#1303
X-original-commit: 624131f712
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
Syntax was added to explicitly specify a module, class or function with
`--test-tags`: b729a11a12
The documentation was not updated to reflect this, leading to confusion
as people tried to reconcile the documentation with the actual behavior,
without necessarily having seen `odoo-bin --help` which is explicit
about it.
closesodoo/documentation#1282
X-original-commit: 77dd769b08
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Raf Geens <raf@odoo.com>
The preferred format for (frontend) references is now:
"frontend/filename/section", or something close to that.
closesodoo/documentation#1294
X-original-commit: 894165a949
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
This commit is a move, but the content was also slightly
updated/reformatted.
closesodoo/documentation#1288
X-original-commit: f206233ebc
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
- add a link to services
- add a note that the env is quite powerful
- reformat the table with the list-table role, to make it easier to edit
closesodoo/documentation#1268
X-original-commit: 1e6c12be30
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
This commit update the registry documentation to use the js domain
directives instead of trying to format functions with code blocks.
I am not impressed with the way it looks, but in any cases, it is
certainly better to properly structure the documentation.
closesodoo/documentation#1262
X-original-commit: ce96d6c584
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
This commit adds a pretty important missing piece of information: the
assets key in the manifest. At the same time, we remove two keys that
are no longer in use.
closesodoo/documentation#1261
X-original-commit: a2a389688c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Now that the reference is split into backend/frontend, it makes more
sense to have the assets page into the frontend section.
closesodoo/documentation#1260
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
The terminology did not really make sense for a lot of these sub pages.
This change should have been done long ago, but was probably delayed
because some people in Odoo call the web client the "backend", which is
really misleading.
This commit also renames the title "Reference Guides" to "Reference",
since this section does not contain any guides anyway.
Part-of: odoo/documentation#1260
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.
closesodoo/documentation#1255
X-original-commit: 26042f541a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit updates the documentation of the map view.
There were missing map attributes, typos and wrong descriptions.
closesodoo/documentation#1232
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
and move the section on environment to the framework main documentation
page.
closesodoo/documentation#1237
X-original-commit: 05ab4a7b0a
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
This commit moves most of the content out of the javascript reference
and into a more visible page.
closesodoo/documentation#1211
X-original-commit: c6f813f4cb
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The default protocol int the POS with "other device"
is on HTTP.
This doc explain how to activate the HTTPS in the POS
closesodoo/documentation#1205
X-original-commit: a160504b8d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The english version has a confusing wording, using "strict ngligence"
instead of "strict liability" in this sentence:
"(...) regardless of the form of action, whether in contract, tort
(including strict negligence) or any other legal (...)"
In FR/BE this would seeem to refer to the notion of "responsabilité
objective" ou "responsabilité sans faute".
Yet this extra precision seems confusing and does not seem to add to the
already broad clause. It seems simpler to omit it.
The typical english wording for this clause is simply:
"regardless of the form of action, whether in contract, tort or otherwise".
Users couldn't click on Paypal and saw the HTTP link instead of only 'Paypal'
closesodoo/documentation#1176
X-original-commit: a4aa310b85
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The plugins were named "Odoo-Gmail Plugin" / "Gmail Plugin" and "Odoo-Outlook Plugin" /
"Outlook Plugin". I chose the later version for both plugins consistently.
I also added a reference to both the Gmail and Outlook docs in the main Mail Plugins doc.
closesodoo/documentation#1171
X-original-commit: 4331177bb6
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
- 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
closesodoo/documentation#1146
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
- 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
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
The test server url for Carvajal T&S was out of date and has been
updated with the correct one. Carvajal has also split into 2
different companies, with new customers using the new company (CSC)
by default but the older company (CTS) still being available for
existing customers. See task 2508208. So the documentation was
updated to include both of them.
CTS (Carvajal T&S) was being used to refer to Carvajal in general,
so to avoid confusion those mentions have been changed to just
"Carvajal" since it can refer to either CTS or CSC.
closesodoo/documentation#1138
X-original-commit: 396df2abdd
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Brings some modification to the documentation on cohort, graph, and
pivot views according to the recent refactoring of the reporting views
in owl.
Related commits:
closesodoo/documentation#1123
Community: odoo/odoo#73311
Enterprise: odoo/enterprise#19469
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Since delivery is now a dependency of `sale_amazon`, the user don't have to
install it anymore. But they are still asked to get a tracking reference, so
this part stay untouched.
task-2635654
closesodoo/documentation#1117
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The list of Mexican accounting modules in the documentation was out of
date, with many of them no longer existing. Several new modules have
been added as well.
closesodoo/documentation#1114
X-original-commit: 5b42479993
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
Signed-off-by: Raf Geens <raf-odoo@users.noreply.github.com>
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
The indentation of the provided default nginx config wasn't consistent.
This commit enforces the indentation of two spaces for the nginx config.
Also cleans a bit the .rst useless empty lines.
This doc page is still frequently used by the support.
This commit partly reverts 16418c020b
to keep the page as a hidden orphan page.
In the future, the content of this page should be moved
in the support contract and/or an independent odoo.com page
- since the merge, the feature name got a different capitalization. This
is updated in the text
- the image is moved after the paragraph with `align:center` as the
`align:right` currently has an overflow issue with the following
admonition.
task-2587075
- since the merge, the feature name got a different capitalization. This
is updated in the text
- the image is moved after the paragraph with `align:center` as the
`align:right` currently has an overflow issue with the following
admonition.
task-2587075
This commit relates to a new community feature:
A read_group on a date(time) field will also return a __range property with
the date bounds of the group [from, to[
The community commit also introduces a new xml attribute
`allow_group_range_value` for `<kanban>` `<field>`, and this commit is the
documentation for that attribute.
allow_group_range_value (boolean):
- to perform a drag&drop or a quickCreate, we must be able to get and use the
value from the group containing the record. The last date of the group will
be taken as the record's field value.
- allows (or disallows) date(time) non-readonly fields to be:
- draggable
- quick created
- defaults to false.
Task-ID: 2243913
Community PR odoo/odoo#69380
Commit: [IMP] core, web: add a range for date(time) read_group
`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
When searching for a string that can be found in a TOC page's content,
that page is listed in the search results. This is not a wanted behavior
because TOC pages without the 'show-content' metadata directive are not
supposed to be accessible.
This commit adds a 'nosearch' metadata directive to all TOC pages
without a 'show-content' metadata directive, hence removing them from
search results.
task-2527419
The padding was not correctly set because the admonition was included
in an <ul> element which was itself inside another <ul> element.
The table below the admonition is also moved outside of the <ul>
because it is semantically incorrect.
The content of the introduction guide is moved to the parent page which
is itself renamed to "Write documentation". The homepage's quick links
are adapted accordingly.
The chance is also taken to move media files in the appropriate folder.
task-2558998
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
Since other docs were moved away from the section "basics" with previous
commits, this category is renamed "users settings"
This commit:
- renames "basics" into "users settings"
- moves the content from "odoo_basics/users" to "users"
- it moves the content about "access rights" to a child doc
task-2535899
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit:
- removes the main "settings" section
- move its content to general/odoo_basics
- moves "general/mobile" content to "general"
- moves the content of the doc "developer_mode/activate" to "general"
- it replaces the references to that doc with `:ref:` directives
rather than `:doc:` directives
- it is worth noting that it also fixes plenty of links that
previously referred to "developer_mode" (the category) rather than
"developer_mode/activate" (the document)
task-2535899
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit merges all docs about data import/export into a single doc:
- base_import/import_faq -> export_import_data
- base_import/adapt_template -> export_import_data
- odoo_basics/export-data -> export_import_data
task-2535899
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit merges all docs about unsplash into a single doc:
- "unsplash/unsplash_access_key" -> unsplash
- "unsplash/unsplash_application_id" -> unsplash
task-2535899
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit improves the structure of the "general" section:
- moves the content of "payment_acquirers/payment_acquirers" to its
parent page, as main content for this category.
It also improves the content of the note about sensitive data.
task-2535899
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit improves the structure of the "general" section:
- it moves the content of the doc "in_app_purchase" to its parent page
"multi_companies"
- it moves the content of the doc "tags/take_tags" to "odoo_basics/tags"
- it moves the content of the doc "manage_multi_companies" to its parent
page "multi_companies"
task-2535899
* readonly is True for related fields.
Since Odoo 12: 52a8ed3c0c
This commit also highlights all the default values of related fields, fixing
the misleading message about related computed in sudo mode (since it can
be disabled with compute_sudo or related_sudo = False)
---
task-2451749
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
```
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit:
- renames "expense" to "expenses" as it is in the app and in the title
- restructures the files
- moves the media files from "media" folder to "expenses" folder
- adds a short intro to expenses
task-2535899
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit improves the structure of the "Accounting" app:
- it moves the doc "in-odoo" in the top "app" level and its content is
included in "accounting.rst" (the content will later be improved)
- adds new intro
- changes external links to mementos to correct doc references
- it renames the category accounting/overview to
accounting/getting_started
- it renames the category accounting/overview/getting_started to
accounting/getting_started/initial_configuration
- it moves "memento" one level above, from
accounting/overview/main_concepts to the renamed
accounting/getting_started as it is the last doc remaining in this
category
- it renames the app "Invoicing and Accounting" to
"Accounting and Invoicing" since the focus should be on "Accounting"
task-2535899
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit improves the structure of the "Sign" app:
- it removes a useless "overview" category
- it adds a brief explanation at the "app" level, including links to
relevant docs
task-2535899
The re sequencing feature done by WAN is perturbing our french customer
In order to explain the reason the feature is, let's state what has been
decided by the product owner (TSB)
opw-2389435
The module ' l10n_fr_certification ' has been integrate in the account module.
so this is not installable anymore. Removed this but kept the explanation
for the POS.
opw-2389435
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>
Updates and Improvements for the Chilean localization:
- Add new Webinar
- Additional explanations.
- Update common errors and important considerations related to FAQ.
This avoids to have URL pointing to
https://www.odoo.com/documentation/user/<VERSION>/<LANG>/odoo_enterprise_agreement.pdf
when switching a language
The pdf are built only once and are global per version
* Change 13.0 references to 14.0
* Change Ubuntu version to 20.04 as it was the stable version at Odoo
release time
* Remove unnecessary postgresql pre-installation as Debian and Ubuntu
install the recommended packages by default
* Replace `root` commands by `sudo` commands as it's the preferred way
to run admin commands
* Remove the manual installation of xlwt and num2words as the Debian
packages now exist.
* Bump the supported Fedora version to Fedora 32.
* Add a warning about unsupported Fedora 33 (because of Python 3.9 that
would need a separate package)
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.
Removes unnecessary, straightforward, easy-to-figure out documentation, as part of an effort to '
clear out any sort of documentation that is either too easy, too simple,
or already gone over in the tutorial videos. This documentation falls into that category. Hence,
it was removed entirely.
As per the documentation, it is possible to show inventory availability under ecommerce without
installing Inventory app which is incorrect. Made the appropriate changes.
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
