This commit also replaces references to the "Building a module"
tutorial by references to the "Getting started" tutorial.
task-2991663
Part-of: odoo/documentation#3644
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#3568
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#3538
Signed-off-by: Castillo Jonathan (jcs) <jcs@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#3446
X-original-commit: f469e4ef81
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#3418
X-original-commit: 92de7ccb2d
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#3249
Added a note on packages and extensions support
closesodoo/documentation#3184
Taskid: 2836438
X-original-commit: b1f92ba879
Signed-off-by: Aarab Tom (toaa) <toaa@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#3142
X-original-commit: 0b9279d5
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#2601
X-original-commit: a92671bd85
Signed-off-by: Castillo Jonathan (jcs) <jcs@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#2501
X-original-commit: 77f4b4b307
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Added document and media files on the setup of Google Gmail using OAuth with Odoo.
closesodoo/documentation#2470
X-original-commit: 9b75dfd2ac
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: f648960c78
Part-of: odoo/documentation#2462
Co-authored-by: Elisabeth Dickinson (edi) <edi@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#2440
X-original-commit: 11460f4c93
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#2368
X-original-commit: 4e67b8986c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
it will also be renamed to .repositories in the near future
closesodoo/documentation#2161
X-original-commit: 1afee9e2c7
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#2064
Since 11.0, the naming scheme changed from `(x.)saas~y` to `saas~x.y`.
closesodoo/documentation#1806
X-original-commit: 30f55dfd72
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@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#1696
X-original-commit: c018a53686
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Backport of commit d227ab66b0 on #1448closesodoo/documentation#1614
X-original-commit: a80f3c3899
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
