Commit Graph

69 Commits

Author SHA1 Message Date
Sam Lieber (sali)
0d6bfc4a57 [ADD] maintain: google oauth doc
Added document and media files on the setup of Google Gmail using OAuth with Odoo.

closes odoo/documentation#2476

X-original-commit: 9b75dfd2ac
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-14 11:42:59 +02:00
Antoine Vandevenne (anv)
61e94177f6 [FIX] odoo_theme: show a cursor when hovering on an image without modal
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: f648960c78
Part-of: odoo/documentation#2467
Co-authored-by: Elisabeth Dickinson (edi) <edi@odoo.com>
2022-07-13 19:56:04 +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
Denis Vermylen
bcc8498c0b [FIX] odoo.sh: remove hidden folder from documentation
it will also be renamed to .repositories in the near future

closes odoo/documentation#2166

X-original-commit: 1afee9e2c7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-08 11:20:34 +02:00
Jason Aerts (jaae)
f477cf5f1c [IMP] maintain: process for odoo.sh to odoo online
task-id 2870122

closes odoo/documentation#2158

X-original-commit: 6dc4288e49
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-06-03 14:36:48 +02:00
Jonathan Castillo (jcs)
235bcf85f2 [IMP] maintain: add note in hosting changes (on-premise to online)
task-id 2869953

closes odoo/documentation#2129

X-original-commit: 4cd0500408
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-06-01 19:32:47 +02:00
Julien Castiaux
0f2b82cb37 [IMP] install/deploy: serve static file/attachment
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.

closes odoo/documentation#2083

Task: 2801675
Related: odoo/odoo#88134
Related: odoo/enterprise#26191
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-01 02:53:55 +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
Jonathan Castillo (jcs)
35da831350 [IMP] install/maintain: add seealso links in domain names doc
closes odoo/documentation#1938

X-original-commit: d7da800674
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-05-06 15:32:00 +02:00
Christophe Simonis
f997758e12 [FIX] supported_versions: correct naming of recent saas~x versions
Since 11.0, the naming scheme changed from `(x.)saas~y` to `saas~x.y`.

closes odoo/documentation#1809

X-original-commit: 30f55dfd72
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-04-06 17:39:51 +02:00
Donatienne Pirlot
ba4f9d6354 [FIX] upgrade: small fixes
task-2684744

closes odoo/documentation#1769

X-original-commit: 6a316ca86e
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-29 12:00:14 +02:00
Eric Macharia
1aa28868e4 [FIX] install/maintain: typo in deploy.rst
closes odoo/documentation#1759

X-original-commit: 5c5ef6e603
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-29 03:31:24 +02:00
Donatienne Pirlot
cb825e247d [IMP] upgrade: update and improve the upgrade processes and information
task ID: 2684744

closes odoo/documentation#1749

X-original-commit: 825e0ede21
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-26 07:12:00 +01:00
Antoine Vandevenne (anv)
c8a1814007 [IMP] supported_versions: flag saas-15.2 as supported
closes odoo/documentation#1745

X-original-commit: ba0e93e836
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-25 19:42:44 +01:00
Antoine Vandevenne (anv)
7316152764 [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#1699

X-original-commit: c018a53686
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-14 11:28:56 +00:00
Jonathan Castillo (jcs)
9ecc73df71 [IMP] install/maintain: add use of :guilabel: in domain_names
+ fix two small typos.

closes odoo/documentation#1681

X-original-commit: 7e51c98636
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-10 14:38:15 +00: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
Stanislas Sobieski
71c45a1525 [FW][REV] odoo_sh: revert commit 6c48f90
closes odoo/documentation#1623

Forward-port-of: odoo/documentation#1618
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-22 17:15:10 +00:00
Obay Abdelgadir
cdf5c7eda4 [IMP] install: remove deprecated ssl instruction in deploy.rst
Backport of commit d227ab66b0 on #1448

closes odoo/documentation#1617

X-original-commit: a80f3c3899
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-22 13:44:14 +00:00
Stanislas Sobieski
d530c8e566 [IMP] odoo_sh doc update
closes odoo/documentation#1610

X-original-commit: 6c48f90739
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-21 17:55:07 +00:00
Jonathan Castillo (jcs)
d8e4894f5b [IMP] install/maintain: add info about upgrading Odoo Online databases
closes odoo/documentation#1582

X-original-commit: 337b36320c
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-11 13:44:03 +00:00
Antoine Vandevenne (anv)
e133c53f52 [IMP] supported_versions: emphasis short-term support of SaaS versions
X-original-commit: 31709ad082
Part-of: odoo/documentation#1582
2022-02-11 13:44:03 +00:00
Antoine Vandevenne (anv)
8d032bae61 [IMP] supported_versions: flag saas-15.1 as supported
X-original-commit: 696ab7de05
Part-of: odoo/documentation#1582
2022-02-11 13:44:03 +00:00
StanvanHoorn
0754e169dc [FIX] install/maintain: update versions in "Installing Odoo"
closes odoo/documentation#1564

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-09 17:03:37 +00:00
Antoine Vandevenne (anv)
cf6ca0fbb2 [IMP] contributing/doc, install: add an extension for content tabs
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

closes odoo/documentation#1528

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Lucie Van Nieuwenhuyse (luvn) <luvn@odoo.com>
2022-02-07 16:44:01 +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
Christophe Monniez
aa1c6b3f07 [IMP] install/setup: install dependencies from debian packages
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

closes odoo/documentation#1364

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-17 12:28:55 +00:00
Perman Atayev
c858f1e095 [IMP] install/maintain: fix a typo
original commit 5098eaf93f
in PR https://github.com/odoo/documentation/pull/1345/

closes odoo/documentation#1408

X-original-commit: 806a96f8cb
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-12-13 18:11:05 +00:00
Moens Alexandre
881aecbe59 [IMP] hosting change: from PaaS to SaaS
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)

closes odoo/documentation#1368

X-original-commit: c3c054681c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-12-08 13:54:03 +00:00
frln
bbaa1856c5 [IMP] administration/install, *: make 3.7 the minimum version for Python
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.

closes odoo/documentation#1255

X-original-commit: 26042f541a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-02 13:33:55 +00:00
Jonathan Castillo (jcs)
6f550c494e [ADD] maintain: revert and update "db_online"
task-2601835

closes odoo/documentation#1221

X-original-commit: d7f4475901
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-25 14:08:03 +00:00
Jonathan Castillo (jcs)
f553a6b744 [IMP] upgrade: create new "upgrade" section in "install and maintain"
closes odoo/documentation#1187

X-original-commit: fd006b4a3c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Jonathan <jcs-odoo@users.noreply.github.com>
2021-10-15 11:45:07 +00:00
Jonathan Castillo (jcs)
a1707b2eb1 [IMP] maintain: on premise filename change and media movement
X-original-commit: 8ca7d66faa
Part-of: odoo/documentation#1187
2021-10-15 11:45:07 +00:00
Jonathan Castillo (jcs)
533e11c19e [IMP] maintain: update versions upgrade
task-2600310

X-original-commit: 84ceee3fda
Part-of: odoo/documentation#1187
2021-10-15 11:45:07 +00:00
Antoine Vandevenne (anv)
fc60cda6e5 [REL] supported_versions: update list of versions and add end of support
closes odoo/documentation#1163

X-original-commit: b28e34b357
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 17:22:11 +00:00
Denis Ledoux
a67e991124 [FIX] maintain: upgrade command line link
closes odoo/documentation#1150

X-original-commit: 7276929071
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-10-05 14:06:01 +02:00
Jonathan Castillo (jcs)
7d9e8af153 [IMP] maintain: update test doc link in versions upgrade
closes odoo/documentation#1141

X-original-commit: 0842b682fc
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 14:06:01 +02:00
Antoine Vandevenne (anv)
17880034b4 [MERGE] Forward-port of branch 14.0 to master 2021-07-29 15:09:12 +02: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
Antoine Vandevenne (anv)
f8f784c0b0 [MERGE] Forward-port of branch 14.0 to master 2021-07-07 15:40:27 +02: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)
94e033c5e8 [MERGE] Forward-port of branch 14.0 to master 2021-06-25 16:03:40 +02:00
Antoine Vandevenne (anv)
245dd60bb4 [MERGE] Forward-port of branch 13.0 to 14.0 2021-06-25 15:59:04 +02:00
Antoine Vandevenne (anv)
7faf5ff926 [MERGE] Forward-port of branch 12.0 to 13.0 2021-06-25 15:51:46 +02:00
Jonathan Castillo
c84ac0f7e4 [IMP] admin/odoo.sh: supported versions in "getting_started/create"
task-2581302
2021-06-24 16:48:17 +02:00
Antoine Vandevenne (anv)
457008fab7 [MERGE] Forward-port of branch 14.0 to master 2021-06-09 12:40:56 +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