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
closesodoo/documentation#5542
X-original-commit: 91c28fd433
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
The notes displayed before and after the tabs under the Git paragraph in install.rst were identical, except for one sentence. Added the sentence to the post-tabs note and removed the pre-tabs one.
X-original-commit: 481a867a05
Part-of: odoo/documentation#5092
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.
closesodoo/documentation#4808
X-original-commit: 8aed7988ba
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Christophe Monniez (moc) <moc@odoo.com>
A complete guide on how to create a custom website theme for Odoo
closesodoo/documentation#4420
X-original-commit: 892fd3e2ac
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
This commit removes unnecessary `proxy_set_headers` in the serve
static config block.
Indeed, the request will either be served by Nginx in which case
the request won't go to the proxy backend or by the `@odoo` backend
which have its own `proxy_set_headers` set as the user is supposed
to copy/paste the contennt of the `location /` block.
closes odoo/documentation#3768
Closes: #3675
X-original-commit: 6129288439
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Stockbauer Matthieu (tsm) <tsm@odoo.com>
This commit also replaces references to the "Building a module"
tutorial by references to the "Getting started" tutorial.
task-2991663
X-original-commit: 4f4e346953
Part-of: odoo/documentation#3660
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#3589
X-original-commit: 7ae76bad42
Signed-off-by: Castillo Jonathan (jcs) <jcs@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#3265
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#3170
X-original-commit: fa2d0f6363
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
In case of a source install the various places where static files can be
found are spread on the filesystem. The previous configuration sample
used custom internal locations but it turns out that it is only possible
to `try_files` on filesystem paths and on "named location (@ ones)".
This commit fixes the configuration sample so that it works for the
given situation where community and enterprise has been cloned from git.
task-3049538
closesodoo/documentation#2945
X-original-commit: 67cb3acd6a
Signed-off-by: Julien Castiaux <juc@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
As the `apt-key` command will is deprecated and will be removed in the
next Debian release, it's time to update the documentation.
closesodoo/documentation#2846
X-original-commit: 1c2d59b280
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Before this commit, following the install documentation to setup
the odoochat server would fail. This was due to the fact that the
documentation about how to define the `$connection_upgrade` variable
was missing.
This PR fixes this issue.
closesodoo/documentation#2829
X-original-commit: 9ed3575f19
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Stockbauer Matthieu (tsm) <tsm@odoo.com>
Update the minimal version in the installation doc
Make all postgresql docs references target the v12 documentation
Fix some non http links on the way
closesodoo/documentation#2822
X-original-commit: 93b383e95d
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
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 this issue.
task-2922249
closesodoo/documentation#2506
X-original-commit: c40cf83073
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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#2480
X-original-commit: 524794c59c
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#2381
X-original-commit: 12ff9f118b
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>
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>
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>
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>
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>
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>
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.
