The coding guidelines establish that we have to write class
declaration for both Python and JavaScript in camel case but
it's actually in Pascal case. It also establishing that model
variable (ex: `Partner = self.env['res.partner]'`) has to be
in camel case but it's actually following the Pascal case.
Pascal case has to start all variables with a capital letter
where camel case is starting with a lower case letter.
Source: https://builtin.com/articles/pascal-case-vs-camel-case
no task id
closesodoo/documentation#14710
X-original-commit: 9fa2ffdeae
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Florian Gilbert (flg) <flg@odoo.com>
Warn our partners to avoid using too generic naming for modules to avoid
potential collisions with future standard odoo modules
no-task
closesodoo/documentation#13584
X-original-commit: 07950cc912
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Anton Romanova (roan) <roan@odoo.com>
Following the fix - 92c7099a0e
Adding a comment to explicitly indicate that the import is ordered
alphabetically based on ASCII values.
closesodoo/documentation#12982
X-original-commit: 8bfb5d5855
Signed-off-by: Harsh Modi (hamo) <hamo@odoo.com>
The link replaced is dead and doesn't lead to anything anymore. The new link is
the exact same page but hosted on another website.
closesodoo/documentation#12550
X-original-commit: b6e7e02734
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Thomas Becquevort (thbe) <thbe@odoo.com>
In odoo, as we suggest everyone to follow an alphebetic order.
The translator(`_`), ASCII is 95 and `a` ASCII value is 97
which '_' < 'a', the translator should be defined first in the
import before the `api` not at the end of the import
This commits adds an example to import static class `Command`
with a Capital alphabet with a ASCII value of `C` as 67
which will be before than the `_`
'C' < '_' < 'a'
This order of import should be followed while the import
closesodoo/documentation#11992
X-original-commit: c7a6b67a87
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The [PERF] commit tag passes the runbot minimal check and has been
used in lots of patches. E.g.
- odoo/odoo@f02bcfadcb
- odoo/odoo@b30b059898
- odoo/odoo@780a2bb601
However this tag was not listed in the documentation yet. This led
to confusion for reviewers not accustomed with it. This commit
fixes that.
closesodoo/documentation#11300
X-original-commit: ac8f3d2aa4
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Aurélien van Delft (avd) <avd@odoo.com>
There have been several new odooers who've hit legal/cla mismatches, and after
investigation their email address would be smart quoted in git (e.g.
`<“uid@example.org”>`).
That the documentation itself uses smart quotes is highly suspicious, it would
make sense that new developers just pasted the provided command, updated it to
match, and didn't even notice the quotes were wrong: `git` is perfectly happy
with it, only on reading it back can you realise it's wrong and the guide
doesn't say anything about *that*.
So fix the quotes in the doc, and hopefully that'll resolve the issue.
closesodoo/documentation#10446
X-original-commit: 811b442fcc
Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com>
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
closesodoo/documentation#8064
Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
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#5543
X-original-commit: 91c28fd433
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
This commit improves the structure of the accounting documentation by
- reducing the levels necessary to reach the information
- grouping some docs
- moving content to their parent category page (content in all levels)
- renaming some sections to reflect the structure of the app better
task-3330093
closesodoo/documentation#4479
X-original-commit: c68cc154ed
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
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.
closesodoo/documentation#4413
X-original-commit: 26e12696c1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
A few python code blocks on the coding guidelines are indented twice
(8 spaces instead of 4), which is not correct.
closesodoo/documentation#3906
X-original-commit: 16176fb508
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
For instance, "Fix a typo"
or "Add documentation for invoicing of sales orders." instead of For instance, "Fix a typo"
or "Add documentation for invoicing of sales orders".
closesodoo/documentation#3736
X-original-commit: da87d72167
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
The extension adds two new directive:
- `cards` is the row container for one or more `card` directives.
- `card` is the implementation of a Bootstrap card that accepts a
`target` argument for the href of the card, a `large` option to render
the card on two columns, a `tag` option to display a single arbitrary
tag on the card, and arbitrary content that is shown in the card
body.
task-3141419
closesodoo/documentation#3689
X-original-commit: 34bc63d2bc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This PR change the cheat sheet of the accounting documentation.
Change done:
* Change name of the file: memento to cheat_sheet
* Adding explanation to the doc (Ex: Invoices and bills status)
* Correcting some sentences
closesodoo/documentation#3625
Task-id: 2847663
X-original-commit: 2fa9de17e1
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
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>
The example for import order is a little confusing since it is wrong.
closesodoo/documentation#3381
X-original-commit: f7b1f66b8c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Nicolas Lempereur (nle) <nle@odoo.com>
Add a new content focused on SCSS and user-interface.
- SCSS coding guidelines: regroup information already available (eg [1])
or based on "oral tradition".
The aim is not to establish new rules, ~99% of the current codebase
is already compliant.
- SCSS inheritance: explain how SCSS assets management works in odoo.
For example, people still find confusing that overrides are defined
*before* the variable to customize.
- SCSS optimization tips: suggestions to lean SCSS code. Based on SCSS
optimization task's know-how [2].
- CSS variables: explain how this feature is commonly used in odoo to
adapt layout & design without raw CSS overrides.
- UI Icons: Add link to fontAwesome4 library . Replace the picture of
odoo icons with the actual font (90kb image VS 15Kb font)
[1] https://github.com/odoo/odoo/wiki/SCSS-coding-guidelines
[2] https://www.odoo.com/web#id=2704984&menu_id=4720&cids=1&model=project.task&view_type=form
task-3090800
closesodoo/documentation#3327
X-original-commit: 2ca32b40bc
Signed-off-by: Antoine Vandevenne (anv) <anv@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
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
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>
It is often needed in developer tutorials to show excerpts of code for
examples and solutions. This takes quite some page space and, for the
latter, it is not always desired to show the final code result right
after the exercise objective.
This commit adds a spoiler feature to the documentation to allow hiding
content until the reader wants to display it.
The feature relies on the new `.. spoiler:: Button label` directive.
task-3036845
closesodoo/documentation#2877
X-original-commit: 4d7a88639a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Morgan Meganck <morm@odoo.com>
Co-authored-by: Stefano Rigano <sri@odoo.com>
act_window & report xml tags have been deprecated by
6835aeb0de
two years ago, we should avoid mentioning them in the guidelines.
Furthermore, in 17.0 they won't be available anymore.
closesodoo/documentation#2862
X-original-commit: 758463edd4
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
