Commit Graph

8 Commits

Author SHA1 Message Date
Audrey (auva)
279527cb73 [IMP] contributing/documentation: update documentation guidelines
task-3709518

closes odoo/documentation#11023

X-original-commit: 9225abb13f
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
2024-09-16 17:01:20 +00:00
Antoine Vandevenne (anv)
632f7c65ce [FIX] contributing/development: fix doc reference to tutorials.rst
closes odoo/documentation#10475

X-original-commit: 747e1bab14
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-07-31 14:19:56 +00:00
Jonathan Castillo (jcs)
0249d9d0a6 [MOV] documentation structure reorganization
This commit aims to improve the documentation's navigability by
redefining some categories' purposes and titles.

There is a redirection rule for each documentation page moved.
This ensures that users won't have a 404 error message.

task-3217827

closes odoo/documentation#8064

Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-03-12 07:08:34 +00:00
Xavier (XPL)
ea53f06197 [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#5543

X-original-commit: 91c28fd433
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2023-08-19 07:58:45 +02:00
Antoine Vandevenne (anv)
fd933208d3 [IMP] tutorials/getting_started: rework the environment setup guide
This commit replaces a big chunk of the instructions relative to the
environment setup with a reference to the equivalent steps listed in the
contribution guide. It also moves the content of the "Create your first
PR" section from chapter 16 to chapter 2, as readers were struggling
with the Git configuration required to push their work to GitHub as they
progressed through the tutorial.

closes odoo/documentation#4413

X-original-commit: 26e12696c1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-05-11 18:25:41 +02:00
Jonathan
918766abe1 [IMP] contributing/dev: add cd command to the git config section
closes odoo/documentation#4259

X-original-commit: 817e332160
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-25 14:07:43 +02:00
Antoine Vandevenne (anv)
f778ba89af [ADD] contributing/development: add a guide to contribute to the codebase
In addition, this commit extracts the git guidelines from the coding
guidelines. This helps link the git guidelines and unclutter the coding
guidelines, which should focus on only the programming languages.

task-2897123

Part-of: odoo/documentation#3265
2023-01-03 20:14:55 +01: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