Commit Graph

21 Commits

Author SHA1 Message Date
Julien Castiaux
9ee92c3a27 [IMP] deploy: reword multi-thread/process section
Many users don't start odoo-bin in --workers (multi-processing) mode but
instead leave the default configuration which use the development/demo
multi-threaded server, even in production.

This commit rewords the section about the difference between the
built-in servers and highlight the many advantages of the
multi-processing on. It repeats that information when it comes to
running a dedicated cron server, that it should use the multi-processing
server instead of the default multi-threading one.

closes odoo/documentation#5176

Fixes: odoo/odoo#88984
Closes: odoo/odoo#128571
Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2023-09-20 15:36:38 +00:00
Martin Trigaux
80e1065dff [IMP] install: clarify Windows is not recommended for prod
It has always been the case informally but write it in the doc.

closes odoo/documentation#5825
2023-09-12 22:13:09 +00:00
Xavier (XPL)
b7d5d04229 [REF] install: move intro to main install page and split by install type
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

closes odoo/documentation#5493

Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2023-08-17 17:33:47 +02:00
Christophe Monniez
8aed7988ba [FIX] deploy: reference the config parameter
The deploy documentation is assuming that `/etc/odoo.conf` is the
default config file, which is not the case.

With this commit, the configuration file references the cli
documentation.

closes odoo/documentation#4785

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-06-20 12:40:45 +02:00
Timothy Kukulka (tiku)
3eb3f74f70 [IMP] Website: rewrite-keycdn-doc
closes odoo/documentation#3472

Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2023-03-13 18:46:58 +01:00
Antoine Vandevenne (anv)
f6ab6d6b99 [MOV] developer/cli: move "Command-line interface (CLI)" to the reference dir
task-2991663

closes odoo/documentation#3629

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-21 16:06:50 +01:00
Antoine Vandevenne (anv)
433e5607ac [MOV] howto/rdtraining: move "Getting started" to the tutorials dir
This commit also replaces references to the "Building a module"
tutorial by references to the "Getting started" tutorial.

task-2991663

Part-of: odoo/documentation#3629
2023-02-21 16:06:47 +01:00
Jonathan Castillo (jcs)
643834ced1 [FIX] *: RST cleanup
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.

closes odoo/documentation#3567

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-14 11:24:31 +01:00
Antoine Vandevenne (anv)
f58bfc49b8 [IMP] contributing/documentation: rewrite the contribution guide
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
2023-01-02 12:03:48 +01:00
Antoine Vandevenne (anv)
0b9279d52f [IMP] conf.py, *: interpolate the version and releases in the content
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

closes odoo/documentation#3051

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-08 10:00:21 +01:00
Jonathan Castillo (jcs)
2be57d669e [IMP] *: consistency for the use of "Odoo Online" (and SaaS)
task-3034812

Part-of: odoo/documentation#2827
2022-10-20 18:58:12 +02:00
Antoine Vandevenne (anv)
4558be3a5e [IMP] install: guide the user through the login page
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.

closes odoo/documentation#2542

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-08-01 15:10:43 +02:00
Benoit Socias
77f4b4b307 [IMP] install: troubleshoot typical problems for Mac users
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

closes odoo/documentation#2495

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-19 10:04:28 +02:00
Antoine Vandevenne (anv)
11460f4c93 [IMP] developer/rdtraining: simplify the development environment setup
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

closes odoo/documentation#2380

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-12 12:34:54 +02:00
Antoine Vandevenne (anv)
4e67b8986c [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#2350

X-original-commit: ad374af15d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-04 10:38:45 +02:00
Eric Macharia
419170689e [FIX] install/maintain: typo in deploy.rst
closes odoo/documentation#1755

X-original-commit: 5c5ef6e603
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-28 18:10:58 +02:00
Antoine Vandevenne (anv)
c123d0b978 [IMP] developer/cli: mention the different ways of calling the CLI
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.

closes odoo/documentation#1695

X-original-commit: b81c121ea0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-14 11:08:24 +00:00
Obay Abdelgadir
a80f3c3899 [IMP] install: remove deprecated ssl instruction in deploy.rst
Backport of commit d227ab66b0 on #1448

closes odoo/documentation#1613

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-22 13:24:55 +00:00
BVE
bf2a9bb23f [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#1525

X-original-commit: cf6af904f9
Signed-off-by: Vergote Baptiste (bve) <bve@odoo.com>
2022-02-06 19:49:38 +00:00
Iago Alonso
098b5c5485 [FIX] administration/*/deploy: enforce consistent indentation in nginx config.
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.
2021-07-22 14:28:36 +02:00
Fabien Pinckaers
16418c020b [IMP] *: introduce tables of contents in top-level app pages 2021-07-07 14:56:38 +02:00