Commit Graph

150 Commits

Author SHA1 Message Date
Jonathan Quique (jqu)
768ab1b586 [IMP] email_communication: can't use Odoo STMP with another mail server
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.

closes odoo/documentation#2771

X-original-commit: 7b21e6001b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-29 14:23:59 +02:00
Tom Aarab (toaa)
cdb71bb807 [IMP] accounting: update + merge of multiple multi-currency pages
task id: 2942040

closes odoo/documentation#2744

X-original-commit: 149353cf72
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Co-authored-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2022-09-21 02:25:58 +02:00
Antoine Vandevenne (anv)
cb8d65d5e3 [MOV] developer/misc: move all pages to a more logical location
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

closes odoo/documentation#2381

X-original-commit: 12ff9f118b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-04 17:47:43 +02:00
Michelle Vu (mivu)
a0a4a2da98 [FW][IMP] calendar: update Google Calendar sync screenshots
Task ID: 2685658

closes odoo/documentation#2090

Forward-port-of: odoo/documentation#1982
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-25 12:46:11 +02:00
Antoine Vandevenne (anv)
8722ea902e [MOV] content/*: move resource files into their related page's directory
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
2022-05-20 14:18:54 +02:00
Antoine Vandevenne (anv)
58be362009 [REF] general: move images in their respective page's folder
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.

closes odoo/documentation#1777

X-original-commit: 4e0a9b615f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-30 14:19:56 +02:00
Zachary Straub (ZST)
22e6fcc760 [ADD] general/digest_emails: add new digest emails docs
closes odoo/documentation#1731

X-original-commit: 5d8246c206
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-21 14:01:09 +01:00
Jonathan Castillo (jcs)
3c552336da [IMP] install/maintain: new improved doc about domain names
task-id 2680490

closes odoo/documentation#1651

X-original-commit: cda64e2678
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-03 17:54:35 +00:00
BVE
f2179ad8a0 [ADD] email_communication: new documentation regarding general emailing
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

closes odoo/documentation#1550

X-original-commit: ce8a02d46a
Signed-off-by: Vergote Baptiste (bve) <bve@odoo.com>
2022-02-07 12:11:43 +00:00
Jonathan Castillo (jcs)
4e0c62ae03 [MOV] payment acquirers: from /general/ (misc. section) to /finance/
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
2022-01-28 13:33:13 +00:00
Antoine Vandevenne (anv)
fd6589cf50 [IMP] paypal: clarify steps to properly configure PayPal
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

closes odoo/documentation#1489

X-original-commit: b97ca3f44d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-26 15:56:50 +00:00
Valentin Chevalier
adf0d83180 [IMP] payment_stripe: add PM supported by Odoo
Add payment methods supported by Odoo

This will inform users of Stripe which payment method we currently
support.

task-2685143

closes odoo/documentation#1483

X-original-commit: 587b2862df
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Valentin Chevalier <vcr@odoo.com>
2022-01-25 15:05:08 +00:00
Demesmaeker
2e869a32e5 [ADD] general/payment_acquirers: add doc on Ogone Webhook Setup
task-2703230

closes odoo/documentation#1458

X-original-commit: dfdbf18afa
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-03 10:05:50 +00:00
Morgane Demesmaeker
6fb8dd6b09 [IMP] general/payment_acquirers: rename and swap some headings
closes odoo/documentation#1363

X-original-commit: 8bfa68e930
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-08 10:30:08 +00:00
Demesmaeker
44a134850b [ADD] general/payment_acquirers: add doc on Stripe Webhook Setup
and ease the way to get the api keys

task-2574512

closes odoo/documentation#1346

X-original-commit: 92ad3e8658
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
2021-12-03 08:41:44 +00:00
Géry Debongnie
d16c2472f5 [IMP] developer: normalize reference in js doc
The preferred format for (frontend) references is now:
"frontend/filename/section", or something close to that.

closes odoo/documentation#1294

X-original-commit: 894165a949
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-04 13:51:11 +00:00
Géry Debongnie
992fbc6ece [IMP] developer: rework section on debug mode
closes odoo/documentation#1290

X-original-commit: b48f0cbad8
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 20:35:04 +00:00
Valentin Chevalier (vcr)
efdff9f6e5 [FIX] payment_acquirers/paypal: broken link
Users couldn't click on Paypal and saw the HTTP link instead of only 'Paypal'

closes odoo/documentation#1176

X-original-commit: a4aa310b85
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-12 14:47:56 +00:00
Xavier
b8ff49a6f1 [IMP] mail plugins: add gmail plugin + update and move outlook plugin
Task ID: 2662764

closes odoo/documentation#1168

X-original-commit: debe8cb393
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-07 20:08:48 +00:00
Demesmaeker
06688f4dc7 [IMP] payment_acquirers: revamp online payment providers' documentation
task-2654702

closes odoo/documentation#1165

X-original-commit: 3a2bbc028b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 17:30:49 +00:00
Antoine Vandevenne (anv)
be1653cc51 [MERGE] Forward-port of branch 13.0 to 14.0 2021-07-07 15:39:35 +02:00
Fabien Pinckaers
16418c020b [IMP] *: introduce tables of contents in top-level app pages 2021-07-07 14:56:38 +02:00
Antoine Vandevenne (anv)
245dd60bb4 [MERGE] Forward-port of branch 13.0 to 14.0 2021-06-25 15:59:04 +02:00
Jonathan Castillo
b423c066f9 [ADD] general: content about installing and upgrading apps and modules
task-2579050
2021-06-23 15:41:40 +02:00
Jonathan Castillo
e55138742f [IMP] general: add intro for "general" + imp uninstalling apps/modules
task-2575136
2021-06-22 14:28:43 +02:00
Jonathan Castillo
5583691ae2 [IMP] general: move content about user deactivation to "users"
task-2575136

- general: move content about user deactivation to "users"
- the content is straighter to the point
2021-06-22 14:28:43 +02:00
Tal Shechtman
d59bc40f4a [IMP] general settings: update google auth
task-2229412
2021-06-15 09:31:15 +02:00
Antoine Vandevenne (anv)
b30f28a3c4 [MERGE] Forward-port of branch 13.0 to 14.0 2021-06-09 12:22:50 +02:00
Antoine Vandevenne (anv)
251438d569 [MERGE] Forward-port of branch 12.0 to 13.0 2021-06-09 12:10:06 +02:00
Antoine Vandevenne (anv)
1d3375f1a8 [IMP] *: exclude empty TOC pages from search results
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
2021-06-09 11:55:34 +02:00
Jonathan Castillo
08f8a3d0c0 [REM] content/applications/*: delete unused images 2021-06-09 09:58:59 +02:00
Jonathan Castillo
193e22492c [MERGE] Forward-port of branch 13.0 to 14.0 2021-06-04 17:21:14 +02:00
Jonathan Castillo
400b3f52b7 [MOV] general: renames "odoo_basics" into "users" + split content
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
2021-06-04 13:51:18 +02:00
Jonathan Castillo
2fb77cf3ff [MOV] general: removes main "settings" section + move content
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
2021-06-04 13:51:18 +02:00
Jonathan Castillo
9493bbf4f4 [IMP] general: merge all docs about data import/export into one doc
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
2021-06-04 13:51:18 +02:00
Jonathan Castillo
8c036a0321 [IMP] general: merge all docs about unsplash into one doc
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
2021-06-04 13:51:18 +02:00
Jonathan Castillo
2b6f89f26e [MOV] general: move "payment_acquirer" content up to its parent page
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
2021-06-04 13:51:18 +02:00
Jonathan Castillo
6940f68cb5 [MOV] general: single docs content up to their parent pages
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
2021-06-04 13:51:18 +02:00
Victor Feyens
a1e7024fa0 [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-31 15:16:09 +02:00
Victor Feyens
40afc9d9f0 [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-31 14:54:23 +02:00
Victor Feyens
becf7a207d [FIX] content/applications/*: typos
found with codespell
2021-05-31 14:44:18 +02:00
Antoine Vandevenne (anv)
1758c674e6 [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-28 17:38:04 +02:00
bonesbe
6dd282f6e1 [IMP] general: add user pref image 2021-05-26 08:31:35 +02:00
Antoine Vandevenne (anv)
4b1a61a7aa [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-21 17:21:55 +02:00
Jonathan Castillo
d66de0d1f2 [IMP] accounting: move in-odoo to top-level TOC page + imp structure
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
2021-05-21 17:13:42 +02:00
Victor Feyens
8ad392222b [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-17 19:00:31 +02:00
Victor Feyens
87ab494b42 [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-17 18:29:11 +02:00
Antoine Vandevenne (anv)
74c9f94d16 [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-04 16:51:07 +02:00
Antoine Vandevenne (anv)
8a6ad77935 [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-04 16:31:06 +02:00
Antoine Vandevenne (anv)
e3fee2cf46 [REF][MOV] documentation apocalypse
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
2021-05-04 15:44:00 +02:00