[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#2337 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
@ -412,7 +412,7 @@ PostgreSQL login, `dbpassword` is the PostgreSQL password
|
||||
and `mydb` is the default database to serve on `localhost:8069`.
|
||||
|
||||
.. seealso::
|
||||
- :doc:`The exhaustive list of arguments for odoo-bin </developer/misc/other/cmdline>`.
|
||||
- :doc:`The exhaustive list of arguments for odoo-bin </developer/cli>`.
|
||||
|
||||
Linux
|
||||
-----
|
||||
@ -583,7 +583,7 @@ Where `CommunityPath` is the path of the Odoo Community installation
|
||||
and `mydb` is the default database to serve on `localhost:8069`.
|
||||
|
||||
.. seealso::
|
||||
- :doc:`The exhaustive list of arguments for odoo-bin </developer/misc/other/cmdline>`.
|
||||
- :doc:`The exhaustive list of arguments for odoo-bin </developer/cli>`.
|
||||
|
||||
Mac OS
|
||||
------
|
||||
@ -747,7 +747,7 @@ Where `CommunityPath` is the path of the Odoo Community installation
|
||||
and `mydb` is the default database to serve on `localhost:8069`.
|
||||
|
||||
.. seealso::
|
||||
- :doc:`The exhaustive list of arguments for odoo-bin </developer/misc/other/cmdline>`.
|
||||
- :doc:`The exhaustive list of arguments for odoo-bin </developer/cli>`.
|
||||
|
||||
.. _setup/install/docker:
|
||||
|
||||
|
@ -167,7 +167,7 @@ In the above commands, the argument:
|
||||
* ``--stop-after-init`` will immediately shutdown the server instance after it completed the operations you asked.
|
||||
|
||||
More options are available and detailed in the
|
||||
:doc:`CLI documentation </developer/misc/other/cmdline>`.
|
||||
:doc:`CLI documentation </developer/cli>`.
|
||||
|
||||
You can find in the logs (*~/logs/odoo.log*) the addons path used by Odoo.sh to run your server.
|
||||
Look for "*odoo: addons paths*":
|
||||
|
@ -42,7 +42,7 @@ instance will be held temporarily unavailable for maintenance reason.
|
||||
|
||||
This method is equivalent to perform an upgrade of the module through the Apps menu,
|
||||
or through the :code:`-u` switch of
|
||||
:doc:`the command line </developer/misc/other/cmdline>`.
|
||||
:doc:`the command line </developer/cli>`.
|
||||
|
||||
In the case the changes in the commit prevent the server to restart,
|
||||
or if the modules update fails,
|
||||
|
@ -68,4 +68,4 @@ Offering my own services
|
||||
I am more than welcome to offer my own IAP services through Odoo Apps! It is the perfect opportunity
|
||||
to get recurring revenue for an ongoing service use rather than — and possibly instead of — a sole
|
||||
initial purchase. Please, find more information at: :doc:`In-App Purchase
|
||||
</developer/misc/api/iap>`.
|
||||
</developer/api/iap>`.
|
||||
|
@ -33,7 +33,7 @@ Installation
|
||||
./odoo-bin --geoip-db= ~/Downloads/GeoLite2-City.mmdb
|
||||
|
||||
.. seealso::
|
||||
- :doc:`CLI documentation </developer/misc/other/cmdline>`.
|
||||
- :doc:`CLI documentation </developer/cli>`.
|
||||
|
||||
.. warning::
|
||||
``GeoIP`` Python library can also be used. However this version is discontinued since January
|
||||
|
@ -1,10 +1,22 @@
|
||||
:nosearch:
|
||||
:show-content:
|
||||
:show-toc:
|
||||
:hide-page-toc:
|
||||
|
||||
============
|
||||
Contributing
|
||||
============
|
||||
|
||||
First, **thank you** for landing here and helping us improve Odoo!
|
||||
|
||||
This documentation section is intended as a guide to making contributions for first-timers and
|
||||
veterans.
|
||||
|
||||
As an open-core project, Odoo accepts contributions from everyone, Odoo employees and members of the
|
||||
Odoo community alike, in all of its open-source `GitHub repositories
|
||||
<https://github.com/orgs/odoo/repositories>`_.
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
|
||||
contributing/documentation
|
||||
contributing/development
|
||||
contributing/documentation
|
||||
|
11
content/contributing/development.rst
Normal file
@ -0,0 +1,11 @@
|
||||
:nosearch:
|
||||
:hide-page-toc:
|
||||
|
||||
===========
|
||||
Development
|
||||
===========
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
|
||||
development/coding_guidelines
|
@ -1,11 +1,9 @@
|
||||
|
||||
.. highlight:: python
|
||||
|
||||
.. _reference/guidelines:
|
||||
|
||||
===============
|
||||
Odoo Guidelines
|
||||
===============
|
||||
=================
|
||||
Coding Guidelines
|
||||
=================
|
||||
|
||||
This page introduces the Odoo Coding Guidelines. Those aim to improve the
|
||||
quality of Odoo Apps code. Indeed proper code improves readability, eases
|
||||
@ -237,7 +235,7 @@ The complete tree of our Odoo module therefore looks like
|
||||
|
||||
.. warning:: Use correct file permissions : folder 755 and file 644.
|
||||
|
||||
.. _reference/guidelines/xml:
|
||||
.. _contributing/development/xml_guidelines:
|
||||
|
||||
XML files
|
||||
=========
|
||||
@ -390,7 +388,7 @@ based upon the first one.
|
||||
...
|
||||
</record>
|
||||
|
||||
.. _reference/guidelines/python:
|
||||
.. _contributing/development/python_guidelines:
|
||||
|
||||
Python
|
||||
======
|
||||
@ -946,7 +944,7 @@ Symbols and Conventions
|
||||
def mail_user_confirm(self):
|
||||
...
|
||||
|
||||
.. _reference/guidelines/js:
|
||||
.. _contributing/development/js_guidelines:
|
||||
|
||||
Javascript and CSS
|
||||
==================
|
||||
@ -1008,7 +1006,7 @@ CSS coding guidelines
|
||||
- Use Bootstrap native classes
|
||||
- Use underscore lowercase notation to name class
|
||||
|
||||
.. _reference/guidelines/git:
|
||||
.. _contributing/development/git_guidelines:
|
||||
|
||||
Git
|
||||
===
|
@ -1,8 +1,8 @@
|
||||
:show-content:
|
||||
|
||||
===================
|
||||
Write documentation
|
||||
===================
|
||||
=============
|
||||
Documentation
|
||||
=============
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
@ -11,8 +11,6 @@ Write documentation
|
||||
documentation/rst_cheat_sheet
|
||||
documentation/rst_guidelines
|
||||
|
||||
**First of all, thank you for landing here and helping us improve the user documentation of Odoo!**
|
||||
|
||||
This introductory guide will help you acquire the tools and knowledge you need to write
|
||||
documentation, whether you plan to make a minor content change or document an application from
|
||||
scratch.
|
||||
|
@ -16,4 +16,6 @@ Learn through tutorials and get help using reference guides.
|
||||
|
||||
developer/howtos
|
||||
developer/reference
|
||||
developer/misc
|
||||
developer/api
|
||||
developer/cli
|
||||
developer/iot
|
||||
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 132 KiB After Width: | Height: | Size: 132 KiB |
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 51 KiB |
Before Width: | Height: | Size: 6.3 KiB After Width: | Height: | Size: 6.3 KiB |
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 30 KiB |
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 44 KiB |
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
Before Width: | Height: | Size: 59 KiB After Width: | Height: | Size: 59 KiB |
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
@ -13,3 +13,5 @@ Tutorials
|
||||
howtos/web
|
||||
howtos/profilecode
|
||||
howtos/company
|
||||
howtos/localization
|
||||
howtos/translations
|
||||
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
@ -1,12 +0,0 @@
|
||||
:nosearch:
|
||||
|
||||
====
|
||||
Misc
|
||||
====
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
|
||||
misc/api
|
||||
misc/i18n
|
||||
misc/other
|
@ -1,11 +0,0 @@
|
||||
:nosearch:
|
||||
|
||||
====================
|
||||
Internationalization
|
||||
====================
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
|
||||
i18n/localization
|
||||
i18n/translations
|
@ -1,12 +0,0 @@
|
||||
:nosearch:
|
||||
|
||||
======
|
||||
Others
|
||||
======
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
|
||||
other/guidelines
|
||||
other/cmdline
|
||||
other/iot
|
@ -1,9 +1,9 @@
|
||||
:nosearch:
|
||||
:types: reference
|
||||
|
||||
================
|
||||
Reference Guides
|
||||
================
|
||||
=========
|
||||
Reference
|
||||
=========
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
|
@ -1342,7 +1342,7 @@ to be translated. The way it currently works is the following:
|
||||
is found.
|
||||
|
||||
Note that translations are explained in more details, from the server point of
|
||||
view, in the document :doc:`/developer/misc/i18n/translations`.
|
||||
view, in the document :doc:`/developer/howtos/translations`.
|
||||
|
||||
There are two important functions for the translations in javascript: *_t* and
|
||||
*_lt*. The difference is that *_lt* is lazily evaluated.
|
||||
|
@ -86,7 +86,7 @@
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ pathto('developer/misc/api/odoo') }}" class="stretched-link">
|
||||
<a href="{{ pathto('developer/api/odoo') }}" class="stretched-link">
|
||||
{{ _("External API") }}
|
||||
</a>
|
||||
</li>
|
||||
@ -97,9 +97,14 @@
|
||||
<p class="text-muted">{{ _("You want to contribute to Odoo but don't know where to start? The tutorials and guidelines are there to help you make Odoo even better.") }}</p>
|
||||
<h5 class="text-muted pt-3 text-uppercase fw_semibold">{{ _("Top Links") }}</h5>
|
||||
<ul class="list-unstyled">
|
||||
<li>
|
||||
<a href="{{ pathto('contributing/development/coding_guidelines') }}" class="stretched-link">
|
||||
{{ _("Coding guidelines") }}
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ pathto('contributing/documentation') }}" class="stretched-link">
|
||||
{{ _("Write documentation") }}
|
||||
{{ _("Documentation") }}
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
|
@ -58,6 +58,16 @@ applications/productivity/discuss/advanced/email_template.rst applications/gener
|
||||
|
||||
applications/settings/users_and_features.rst applications/general.rst # settings/users_and_features -> general
|
||||
|
||||
# developer/misc
|
||||
|
||||
developer/misc/api/iap.rst developer/api/iap.rst # better location for misc/ content (#2337)
|
||||
developer/misc/api/odoo.rst developer/api/odoo.rst # better location for misc/ content (#2337) /!\ renamed to external_api.rst in 14.0 /!\
|
||||
developer/misc/i18n/localization.rst developer/howtos/localization.rst # better location for misc/ content (#2337) /!\ already moved in 14.0 /!\
|
||||
developer/misc/i18n/translations.rst developer/howtos/translations.rst # better location for misc/ content (#2337) /!\ already moved in 14.0 /!\
|
||||
developer/misc/other/cmdline.rst developer/cli.rst # better location for misc/ content (#2337)
|
||||
developer/misc/other/guidelines.rst contributing/development/coding_guidelines.rst # better location for misc/ content (#2337)
|
||||
developer/misc/other/iot.rst developer/iot.rst # better location for misc/ content (#2337)
|
||||
|
||||
# services
|
||||
|
||||
services/support/supported_versions.rst administration/maintain/supported_versions.rst # services/support/* -> administration/maintain/*
|
||||
|