This PR change the cheat sheet of the accounting documentation.
Change done:
* Change name of the file: memento to cheat_sheet
* Adding explanation to the doc (Ex: Invoices and bills status)
* Correcting some sentences
closesodoo/documentation#3045
Task-id: 2847663
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
This commit changes the characters used as heading delimiters in the
/legal/ folder of the documentation. This makes it easier for writers to
figure out the heading order as all other files in this repository use
the same order of heading delimiters characters.
closesodoo/documentation#3548
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
RST cleanup to comply with the RST guidelines. This is required so we
can use "make test", as there are currently hundreds of errors. For now,
it is unusable because of the oldest code in this repo.
closesodoo/documentation#3567
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Friday afternoon cleanup. This is required so we can use "make test", as
there are currently hundreds of errors. For now, it is unusable because
of the oldest code in this repo.
closesodoo/documentation#3536
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
The content written in the fiscal localisation pages are not only for
Accounting, but also for other apps such as Payroll and Point of Sales.
This commit moves the content to the "Finance" level, to better reflect
this reality, and merges the pages in the /overview/ folder in the main
category page.
closesodoo/documentation#3535
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Moving the Manage vendor bills page from the accounting app to the purchase app as it is
more relevant.
closesodoo/documentation#3302
Taskid: 2687652
Signed-off-by: Zachary Straub <zst@odoo.com>
The Service Level Agreement has to be updated. Any additional line of
code, without using studio, in standard modules is not supposed to be
covered by the upgrade team. It is slightly different than the point
telling "development of custom modules"
closesodoo/documentation#3445
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
The maintenance fees cover the maintenance of the custom code (whoever
did it) and are not specifically dedicated to custom code written by
Odoo development teams
closesodoo/documentation#3410
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
The goal of this commit is to propose a first step towards a new
`.. card::` directive for the toctrees. This is a first design
proposition for this new card component in raw html for the fallback
page `howtos.rst`
The long term objective is to redesign the toctrees by implementing card
components, clearer toctree list design and custom html pages.
Related to task-3059229
closesodoo/documentation#3326
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The example for import order is a little confusing since it is wrong.
closesodoo/documentation#3376
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Removed old and probably not needed image of the dashboard showing the Contacts App
closesodoo/documentation#3137
Signed-off-by: Zachary Straub <zst@odoo.com>
note: version not bumped for ES translation, since it needs other updates
first
opw-3094638
closesodoo/documentation#3309
Signed-off-by: Olivier Dony (odo) <odo@odoo.com>
This commit restructures the contributing/documentation page to re-use
content introduced with the contributing/development page and to
display the two ways to contribute (github vs git) in content tabs
rather than sections.
The guide is simplified and updated to delegate long explanations to
other pages or websites, remove useless images and focus on getting
users ready to contribute.
task-2897123
Part-of: odoo/documentation#3169
In addition, this commit extracts the git guidelines from the coding
guidelines. This helps link the git guidelines and unclutter the coding
guidelines, which should focus on only the programming languages.
task-2897123
Part-of: odoo/documentation#3169
If committed, this will add a more elaborate warning on what users must
do before syncing Odoo Calendar and Outlook Calendar. It also removes
mentions of the import/export process and archiving events, as these
methods will not prevent email spam from Outlook.
closesodoo/documentation#2925closesodoo/documentation#3243
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Added a paragraph on users wishing to use the same payment provider across
multiple companies.
closesodoo/documentation#3150
Taskid: 3095103
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
In chapter 14 there was a line pointing to how to deduce a default journal for an `account.move` record.
This is no longer needed as the journal is automatically deduced using the `move_type`. Also, the link
point to an outdated line of code that causes an error.
closesodoo/documentation#3172
Signed-off-by: Horacio Tellez Perez (hote) <hote@odoo.com>
This commit replaces hard-coded occurrences of the version and of the
last, current and next releases' version with placeholders interpolated
at build time to avoid manually updating these after each freeze.
task-2917614
closesodoo/documentation#3051
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Prior to this commit, the terms and conditions were displayed in a table
with all the languages and it was not practical for the futur, with many
more languages.
task-3073198
closesodoo/documentation#3058
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Task: 2543815
Cherry pick from #998
Omitted changes proposed in the **track_leads** directory (e.g. `lead_scoring.rst` + image folder). Both the content and image updates were already pushed from another PR so what was proposed on #998 was outdated and no longer necessary.
What’s left over are the original proposed changes in #998, within the **acquire_leads** directory which include updates to `lead_mining.rst` and corresponding image files.
On top of these proposals, I went ahead and made the following changes:
- renamed the image files in the asset directory, since they were using outdated naming convention (e.g. LM1.png, LM6.png, LM7.png)
- cleaned up rst formatting issues (headings, line breaks, added guilabels, etc.)
- rewrote document so content was more concise + followed content guidelines. You can see the first version of proposals here to compare the changes made.
closesodoo/documentation#2535
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
V14 has a dedicated "Fees" tab for PayPal, current documentation does not reflect that.
closesodoo/documentation#3074
Taskid: 3089273
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
GitHub requires users to "use token-based authentication for all
authenticated operations", for example `git push`. See
https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/
This commit suggests new contributors to clone the repository with SSH
so that the remote URL is automatically configured with the SSH
protocol.
task-3036845
closesodoo/documentation#3036
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Add more details as of how to set Adyen Event URLs.
This is important to configure as it is necessary to
receive a callback from Adyen terminal when a transaction
have been done.
OPW-3041117
OPW-3041117
closesodoo/documentation#3009
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
This tutorial was already outdated in 13.0 (but
supposedly working).
In 14.0+, a lot of changes happened in website logic,
especially for 'website option definitions', breaking
the existing theme tutorial.
Considering the fact that a new tutorial is being made,
and that fixing the whole existing tutorial would be
a big work, it will be kept, but hidden as 'most things
being said still make sense'.
closesodoo/documentation#2998
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
New page to document cash reconciliation, and fixed other H1 titles that should have
been in small caps. Forward up to V15.
task id: 3000530
closesodoo/documentation#2796
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Add more details as of how to connect a screen to the IoT box
and how it can be used.
OPW-2962462
closesodoo/documentation#2935
X-original-commit: 21edc4fcc7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
It is often needed in developer tutorials to show excerpts of code for
examples and solutions. This takes quite some page space and, for the
latter, it is not always desired to show the final code result right
after the exercise objective.
This commit adds a spoiler feature to the documentation to allow hiding
content until the reader wants to display it.
The feature relies on the new `.. spoiler:: Button label` directive.
task-3036845
closesodoo/documentation#2837
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Morgan Meganck <morm@odoo.com>
Co-authored-by: Stefano Rigano <sri@odoo.com>
The "(at that time") wording could be confusing - the goal was really to
refer to the price at the time of the deviation, not the price at the
conclusion of the agreement. This should be clearer.
Validated with SBR.
act_window & report xml tags have been deprecated by
6835aeb0de
two years ago, we should avoid mentioning them in the guidelines.
Furthermore, in 17.0 they won't be available anymore.
closesodoo/documentation#2857
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
This way we don't need to update the links nor risk a desynchronization
between the version of the PDF and the HTML.
Previously version 15.0 and 16.0 still referenced the 14.0 PDFs
(which are the same at the moment, but still...)
Customer may want to use their own SMTP for email marketing, and Odoo default SMTP for everything else. There is no good way to do this. Previously we suggested adding Odoo SMTP as an outgoing email server but we don't want to share credentials anymore.
R&D is working on a solution (e.g. showing the Odoo default email server in the list rather than keeping it as an "hidden feature") but for the time being, if you use an outgoing email server, you give up using the Odoo default SMTP.
closesodoo/documentation#2740
X-original-commit: d1317812e1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Adds explanations and directive for module category creation, so it can be used correctly at res.groups creation.
closesodoo/documentation#2721
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Ambiguous note which implied local payment methods were supported even if not listed.
Forward up to V14, create new for V15.
task id: 2942093
closesodoo/documentation#2640
X-original-commit: 4b9517ead1
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Foreign currency page was V13 only and outdated. Updated for V14.
task - 2904025
closesodoo/documentation#2383
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Correction to a typo that made the line completly nonsensical and made
people think that they could migrate just part of the database.
opw-2947684
closesodoo/documentation#2600
X-original-commit: a92671bd85
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Even though the documentation was correct, it was confusing the reader
to state that local payment methods are considered enabled if their
related payment icon record does not exist in the database. The intended
meaning was that this statement only holds if the local payment method
is also supported, otherwise it cannot be enabled.
closesodoo/documentation#2587
X-original-commit: 80a9cfb68f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
In the toctree, "MRP" wasn't capitalized in "Inventory & MRP."
Affects all branches, can be forward ported.
closesodoo/documentation#2561
X-original-commit: 8c665643ce
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Developers sometimes have a hard time making the difference between the
PostgreSQL user and the internal user. They would try to log into Odoo's
web client with their PostgreSQL credentials rather than with admin. See
https://reddit.com/r/Odoo/comments/w8zubf/logging_in_on_source_install.
closesodoo/documentation#2542
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The referenced `bypass.py` file isn't specified anywhere in
the training documentation or code content.
The paragraph is removed to avoid meaningless searches and
confusing trainees.
This commit also adds a missing parenthese in the preceding
code content.
Fixes#2488closesodoo/documentation#2518
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The warning about float utils does not state where to find them, and
they are preceded by an example in the code that infringes the warning's
recommendation.
This commit indicates where to find the float utils and replaces the
example by one that uses them.
task-2925402
closesodoo/documentation#2507
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
As mentioned in [1], because of [2], some python implementation for Mac
fail on startup with default parameters.
Also, when installing requirements, the psycopg requirement can fail
because the $PATH does not contain the postgresql tools installed with
the .app.
This commit provides instructions to avoid those issues.
[1]: https://github.com/odoo/odoo/issues/79112
[2]: https://bugs.python.org/issue40518
task-2922249
closesodoo/documentation#2495
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Google deprecated both its "Universal Analytics" and "Google Sign-In"
API. See community counterpart commit for a detailed explanation and
links.
closesodoo/documentation#2441
X-original-commit: 2222142127
Related: odoo/odoo#95847
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Romain Derie (rde) <rde@odoo.com>
Added document and media files on the setup of Google Gmail using OAuth with Odoo.
closesodoo/documentation#2469
X-original-commit: 9b75dfd2ac
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
If committed, this will delete mentions of project tasks in the "Invoice
Time Spent on Tickets (Postpaid Support Services)" v14.0 user doc. It
also deletes unnecessary steps and screenshots about creating and
configuring a new Project and updates the steps and screenshots for the
"Create a sales order" and "Link the Helpdesk ticket to the SO" sections.
Fixes PR #1901
Closes Odoo Task 2870104
closesodoo/documentation#2204
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Prior to this commit, the /legal.html page relied on RST substitutions
to insert the images directives of legal agreements within the table.
This caused Sphinx to omit the `image-reference` class on all `<a>`
elements surrounding an `<img>` element, which it normally adds when the
`target` option is specified on an `image` directive. As the theme
relies on that class to hide the "external link" icon added with commit
343decf1, the layout of the page was broken.
While replacing the substitutions with the plain `image` directive, the
grid table is converted to a list table to avoid the hassle of expanding
table cells to fit the directives. This will also help in maintaining
the content of the table when we will add new translations for the legal
agreements.
task-2909167
closesodoo/documentation#2461
X-original-commit: 2bf2604
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The images that have the class `o-no-modal` cannot be clicked to open in
a modal, so the cursor should not be changed to a pointer when hovering
on them.
This commit also simplifies the theme's SCSS by replacing the hard-coded
SVG images used in the "Supported versions" page by unicode circles with
a custom styling.
X-original-commit: 556cd6b
Part-of: odoo/documentation#2461
Co-authored-by: Elisabeth Dickinson (edi) <edi@odoo.com>
Since clicking on the image redirects the user to the target URL, it's
useless to open the image in a modal. Also, it partially broke the
layout of the /legal.html page due to the modal div being inserted into
table cells.
This commit also introduces the possibility to add the `o-no-modal`
class on images that should not open in a modal.
task-2909167
X-original-commit: 54d676c
Part-of: odoo/documentation#2461
In an attempt to help new developers install Odoo with a
straightforward procedure, Chapter 2 of the "Getting started" tutorial
included copy-pastes of parts of the "Installing Odoo" page. This proved
to be inefficient because it required maintaining documentation on the
installation procedure in several places and misled the readers by
suggesting installing the Python requirements *after* installing
PostgreSQL.
With this commit, the page on Chapter 2 is refreshed to be clearer to
the readers and redirect them to the "Installing Odoo" page when
necessary.
task-2908434
closesodoo/documentation#2380
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
task - 2904108 I removed the "website/publish" section from the toctree to add a link to the full website documentation inside off the see also.
closesodoo/documentation#2414
X-original-commit: 7307dac6a6
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Task ID:2893426
Since Six payment terminal won't be usable starting in July 2022, I
added this warning.
closesodoo/documentation#2413
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Both carrier name and tracking reference are now displayed to the
customer, even when using the carrie `Self Delivery`
task-2900803
closesodoo/documentation#2406
X-original-commit: 471d0c2094
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Before this commit, the "Developer/Misc" directory of the doc, and
more particularly the "Developer/Misc/Other" sub-directory, was used as
a garbage dump where we moved all the pages that didn't fit elsewhere.
Due to that, interesting and important pages, such as the Coding
Guidelines, were buried in that directory never to be read again by Odoo
developers.
This commit moves most pages under "Misc" one or two levels up to be
located directly under "Developer" hence making them more accessible. A
new "Contributing/Development" directory is added to host the Coding
Guidelines page and soon many other pages.
task-2897143
closesodoo/documentation#2350
X-original-commit: ad374af15d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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#2329
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Following a technical task regarding the migration of the Adyen hosted
payment page integration to Adyen PayByLink, some new parameters have
been introduced and some have been removed.
This new addition to the documentation will help users configure their
acquirer.
task-2802921
closesodoo/documentation#2306
X-original-commit: 0db39e3564
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#2286
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
V13 and V14 do not allow customers with no account on Odoo.com portal to pay through payment acquirers with payment flow "Payment from Odoo"
task - 2711962
closesodoo/documentation#2290
X-original-commit: 103c17f235
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@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#2267
X-original-commit: 80c7b27827
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#2244
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#2180
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#2181
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
it will also be renamed to .repositories in the near future
closesodoo/documentation#2160
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#2132
X-original-commit: e4fc5f07ee
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Aarab Tom (toaa) <toaa@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#2102
X-original-commit: 80408ca
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
If merged, this will update the screenshot for the "Connect a SIX Payment Terminal to your PoS" v14 user doc. In Odoo v14.0, the "Use a Payment Terminal" field only has "Six" as an option, not "Six without IoT Box." The new screenshot reflects this change and I also rewrote the step to reflect this change.
I also added alt text to the images, fixed the image file names, and fixed the image file folder name.
Related issue: https://github.com/odoo/documentation/issues/954closesodoo/documentation#2008
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#2026
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#2026
