diff --git a/content/administration/install/install.rst b/content/administration/install/install.rst index 96feb8775..f48f04c49 100644 --- a/content/administration/install/install.rst +++ b/content/administration/install/install.rst @@ -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 `. + - :doc:`The exhaustive list of arguments for odoo-bin `. 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 `. + - :doc:`The exhaustive list of arguments for odoo-bin `. 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 `. + - :doc:`The exhaustive list of arguments for odoo-bin `. .. _setup/install/docker: diff --git a/content/administration/odoo_sh/advanced/containers.rst b/content/administration/odoo_sh/advanced/containers.rst index 62e8ba7fe..21987bede 100644 --- a/content/administration/odoo_sh/advanced/containers.rst +++ b/content/administration/odoo_sh/advanced/containers.rst @@ -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 `. +:doc:`CLI documentation `. 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*": diff --git a/content/administration/odoo_sh/getting_started/branches.rst b/content/administration/odoo_sh/getting_started/branches.rst index 55abf0b57..af793badc 100644 --- a/content/administration/odoo_sh/getting_started/branches.rst +++ b/content/administration/odoo_sh/getting_started/branches.rst @@ -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 `. +:doc:`the command line `. In the case the changes in the commit prevent the server to restart, or if the modules update fails, diff --git a/content/applications/general/in_app_purchase.rst b/content/applications/general/in_app_purchase.rst index 47d2e50b4..424eee399 100644 --- a/content/applications/general/in_app_purchase.rst +++ b/content/applications/general/in_app_purchase.rst @@ -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 -`. +`. diff --git a/content/applications/websites/website/publish/on-premise_geo-ip-installation.rst b/content/applications/websites/website/publish/on-premise_geo-ip-installation.rst index bbc58350c..66e0fb797 100644 --- a/content/applications/websites/website/publish/on-premise_geo-ip-installation.rst +++ b/content/applications/websites/website/publish/on-premise_geo-ip-installation.rst @@ -33,7 +33,7 @@ Installation ./odoo-bin --geoip-db= ~/Downloads/GeoLite2-City.mmdb .. seealso:: - - :doc:`CLI documentation `. + - :doc:`CLI documentation `. .. warning:: ``GeoIP`` Python library can also be used. However this version is discontinued since January diff --git a/content/contributing.rst b/content/contributing.rst index 3448ca1a5..157d5a698 100644 --- a/content/contributing.rst +++ b/content/contributing.rst @@ -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 +`_. + .. toctree:: :titlesonly: - contributing/documentation \ No newline at end of file + contributing/development + contributing/documentation diff --git a/content/contributing/development.rst b/content/contributing/development.rst new file mode 100644 index 000000000..6016fa59c --- /dev/null +++ b/content/contributing/development.rst @@ -0,0 +1,11 @@ +:nosearch: +:hide-page-toc: + +=========== +Development +=========== + +.. toctree:: + :titlesonly: + + development/coding_guidelines diff --git a/content/developer/misc/other/guidelines.rst b/content/contributing/development/coding_guidelines.rst similarity index 99% rename from content/developer/misc/other/guidelines.rst rename to content/contributing/development/coding_guidelines.rst index bbdafd243..24c1a71a2 100644 --- a/content/developer/misc/other/guidelines.rst +++ b/content/contributing/development/coding_guidelines.rst @@ -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 @@ -238,7 +236,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 ========= @@ -391,7 +389,7 @@ based upon the first one. ... -.. _reference/guidelines/python: +.. _contributing/development/python_guidelines: Python ====== @@ -950,7 +948,7 @@ Symbols and Conventions def mail_user_confirm(self): ... -.. _reference/guidelines/js: +.. _contributing/development/js_guidelines: Javascript and CSS ================== @@ -1012,7 +1010,7 @@ CSS coding guidelines - Use Bootstrap native classes - Use underscore lowercase notation to name class -.. _reference/guidelines/git: +.. _contributing/development/git_guidelines: Git === diff --git a/content/contributing/documentation.rst b/content/contributing/documentation.rst index c0fdb3f5b..46fdd7d2c 100644 --- a/content/contributing/documentation.rst +++ b/content/contributing/documentation.rst @@ -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. diff --git a/content/developer.rst b/content/developer.rst index 01bc598e0..44ea0ba60 100644 --- a/content/developer.rst +++ b/content/developer.rst @@ -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 diff --git a/content/developer/misc/api.rst b/content/developer/api.rst similarity index 100% rename from content/developer/misc/api.rst rename to content/developer/api.rst diff --git a/content/developer/misc/api/external_api.rst b/content/developer/api/external_api.rst similarity index 100% rename from content/developer/misc/api/external_api.rst rename to content/developer/api/external_api.rst diff --git a/content/developer/misc/api/external_api/account-security.png b/content/developer/api/external_api/account-security.png similarity index 100% rename from content/developer/misc/api/external_api/account-security.png rename to content/developer/api/external_api/account-security.png diff --git a/content/developer/misc/api/external_api/delete-key.png b/content/developer/api/external_api/delete-key.png similarity index 100% rename from content/developer/misc/api/external_api/delete-key.png rename to content/developer/api/external_api/delete-key.png diff --git a/content/developer/misc/api/external_api/preferences.png b/content/developer/api/external_api/preferences.png similarity index 100% rename from content/developer/misc/api/external_api/preferences.png rename to content/developer/api/external_api/preferences.png diff --git a/content/developer/misc/api/extract_api.rst b/content/developer/api/extract_api.rst similarity index 100% rename from content/developer/misc/api/extract_api.rst rename to content/developer/api/extract_api.rst diff --git a/content/developer/misc/api/extract_api/implementation.py b/content/developer/api/extract_api/implementation.py similarity index 100% rename from content/developer/misc/api/extract_api/implementation.py rename to content/developer/api/extract_api/implementation.py diff --git a/content/developer/misc/api/iap.rst b/content/developer/api/iap.rst similarity index 100% rename from content/developer/misc/api/iap.rst rename to content/developer/api/iap.rst diff --git a/content/developer/misc/api/iap/button.png b/content/developer/api/iap/button.png similarity index 100% rename from content/developer/misc/api/iap/button.png rename to content/developer/api/iap/button.png diff --git a/content/developer/misc/api/iap/creating_service.png b/content/developer/api/iap/creating_service.png similarity index 100% rename from content/developer/misc/api/iap/creating_service.png rename to content/developer/api/iap/creating_service.png diff --git a/content/developer/misc/api/iap/credits.jpg b/content/developer/api/iap/credits.jpg similarity index 100% rename from content/developer/misc/api/iap/credits.jpg rename to content/developer/api/iap/credits.jpg diff --git a/content/developer/misc/api/iap/flow.png b/content/developer/api/iap/flow.png similarity index 100% rename from content/developer/misc/api/iap/flow.png rename to content/developer/api/iap/flow.png diff --git a/content/developer/misc/api/iap/menu.png b/content/developer/api/iap/menu.png similarity index 100% rename from content/developer/misc/api/iap/menu.png rename to content/developer/api/iap/menu.png diff --git a/content/developer/misc/api/iap/no-credit.png b/content/developer/api/iap/no-credit.png similarity index 100% rename from content/developer/misc/api/iap/no-credit.png rename to content/developer/api/iap/no-credit.png diff --git a/content/developer/misc/api/iap/normal.png b/content/developer/api/iap/normal.png similarity index 100% rename from content/developer/misc/api/iap/normal.png rename to content/developer/api/iap/normal.png diff --git a/content/developer/misc/api/iap/package.png b/content/developer/api/iap/package.png similarity index 100% rename from content/developer/misc/api/iap/package.png rename to content/developer/api/iap/package.png diff --git a/content/developer/misc/api/iap/players.png b/content/developer/api/iap/players.png similarity index 100% rename from content/developer/misc/api/iap/players.png rename to content/developer/api/iap/players.png diff --git a/content/developer/misc/api/iap/service_created.png b/content/developer/api/iap/service_created.png similarity index 100% rename from content/developer/misc/api/iap/service_created.png rename to content/developer/api/iap/service_created.png diff --git a/content/developer/misc/api/iap/service_list.png b/content/developer/api/iap/service_list.png similarity index 100% rename from content/developer/misc/api/iap/service_list.png rename to content/developer/api/iap/service_list.png diff --git a/content/developer/misc/other/cmdline.rst b/content/developer/cli.rst similarity index 100% rename from content/developer/misc/other/cmdline.rst rename to content/developer/cli.rst diff --git a/content/developer/howtos.rst b/content/developer/howtos.rst index 1b5972acf..ed25aaece 100644 --- a/content/developer/howtos.rst +++ b/content/developer/howtos.rst @@ -13,3 +13,5 @@ Tutorials howtos/backend howtos/profilecode howtos/company + howtos/localization + howtos/translations diff --git a/content/developer/misc/i18n/localization.rst b/content/developer/howtos/localization.rst similarity index 100% rename from content/developer/misc/i18n/localization.rst rename to content/developer/howtos/localization.rst diff --git a/content/developer/howtos/rdtraining/16_guidelines_pr.rst b/content/developer/howtos/rdtraining/16_guidelines_pr.rst index 435a05947..319d594e4 100644 --- a/content/developer/howtos/rdtraining/16_guidelines_pr.rst +++ b/content/developer/howtos/rdtraining/16_guidelines_pr.rst @@ -14,7 +14,8 @@ We will start refactoring the code to match to the Odoo coding guidelines. The g to improve the quality of the Odoo Apps code. -**Reference**: you will find the Odoo coding guidelines in :ref:`reference/guidelines`. +**Reference**: you will find the Odoo coding guidelines in +:doc:`/contributing/development/coding_guidelines`. .. exercise:: Polish your code. @@ -88,7 +89,8 @@ Commit your code: **Everyone reads your commit messages!** -The commit message is very important, follow the :ref:`Developer guidelines `. +The commit message is very important, follow the :ref:`Git guidelines +`. Push your new branch to your development repository: diff --git a/content/developer/howtos/rdtraining/B_acl_irrules.rst b/content/developer/howtos/rdtraining/B_acl_irrules.rst index 2c0c5f391..2edbff763 100644 --- a/content/developer/howtos/rdtraining/B_acl_irrules.rst +++ b/content/developer/howtos/rdtraining/B_acl_irrules.rst @@ -54,7 +54,7 @@ Groups The documentation related to this topic can be found in :ref:`the security reference `. - :ref:`The guidelines ` document the format and + :doc:`/contributing/development/coding_guidelines` document the format and location of master data items. .. admonition:: **Goal** @@ -481,7 +481,7 @@ or a *visibility* feature before using it: * *Visibility* features mean a user can still access the model or record otherwise, either through an other part of the interface or by :doc:`perform - operations remotely using RPC <../../misc/api/external_api>`, things might just not be + operations remotely using RPC <../../api/external_api>`, things might just not be visible in the web interface in some contexts. * *Security* features mean a user can not access records, fields or operations. diff --git a/content/developer/misc/i18n/translations.rst b/content/developer/howtos/translations.rst similarity index 100% rename from content/developer/misc/i18n/translations.rst rename to content/developer/howtos/translations.rst diff --git a/content/developer/misc/i18n/translations/po-export.png b/content/developer/howtos/translations/po-export.png similarity index 100% rename from content/developer/misc/i18n/translations/po-export.png rename to content/developer/howtos/translations/po-export.png diff --git a/content/developer/misc/other/iot.rst b/content/developer/iot.rst similarity index 100% rename from content/developer/misc/other/iot.rst rename to content/developer/iot.rst diff --git a/content/developer/misc.rst b/content/developer/misc.rst deleted file mode 100644 index 0b30597af..000000000 --- a/content/developer/misc.rst +++ /dev/null @@ -1,12 +0,0 @@ -:nosearch: - -==== -Misc -==== - -.. toctree:: - :titlesonly: - - misc/api - misc/i18n - misc/other diff --git a/content/developer/misc/i18n.rst b/content/developer/misc/i18n.rst deleted file mode 100644 index 3069e91ad..000000000 --- a/content/developer/misc/i18n.rst +++ /dev/null @@ -1,11 +0,0 @@ -:nosearch: - -==================== -Internationalization -==================== - -.. toctree:: - :titlesonly: - - i18n/localization - i18n/translations diff --git a/content/developer/misc/other.rst b/content/developer/misc/other.rst deleted file mode 100644 index 3feffe256..000000000 --- a/content/developer/misc/other.rst +++ /dev/null @@ -1,12 +0,0 @@ -:nosearch: - -====== -Others -====== - -.. toctree:: - :titlesonly: - - other/guidelines - other/cmdline - other/iot diff --git a/content/developer/reference.rst b/content/developer/reference.rst index 4d9a26558..c488b8dc9 100644 --- a/content/developer/reference.rst +++ b/content/developer/reference.rst @@ -1,9 +1,9 @@ :nosearch: :types: reference -================ -Reference Guides -================ +========= +Reference +========= .. toctree:: :titlesonly: diff --git a/content/developer/reference/javascript/javascript_reference.rst b/content/developer/reference/javascript/javascript_reference.rst index 31e47e5e6..b1fca0724 100644 --- a/content/developer/reference/javascript/javascript_reference.rst +++ b/content/developer/reference/javascript/javascript_reference.rst @@ -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. diff --git a/extensions/odoo_theme/layout_templates/homepage.html b/extensions/odoo_theme/layout_templates/homepage.html index f7bd8edad..4831a0095 100644 --- a/extensions/odoo_theme/layout_templates/homepage.html +++ b/extensions/odoo_theme/layout_templates/homepage.html @@ -86,7 +86,7 @@
  • - + {{ _("External API") }}
    • @@ -97,9 +97,14 @@

    {{ _("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.") }}

    {{ _("Top Links") }}
      +
    • + + {{ _("Coding guidelines") }} + +
    • - {{ _("Write documentation") }} + {{ _("Documentation") }}
    • diff --git a/redirects/13.0.txt b/redirects/13.0.txt index 35a35d7ee..603d71537 100644 --- a/redirects/13.0.txt +++ b/redirects/13.0.txt @@ -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/external_api.rst # better location for misc/ content (#2350) /!\ 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 15.0 /!\ +developer/misc/i18n/translations.rst developer/howtos/translations.rst # better location for misc/ content (#2337) /!\ already moved in 15.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/* diff --git a/redirects/14.0.txt b/redirects/14.0.txt index a687dd04c..61ca216f7 100644 --- a/redirects/14.0.txt +++ b/redirects/14.0.txt @@ -5,7 +5,7 @@ applications/sales/crm/acquire_leads/generate_from_website.rst applications/sale # developer/misc -developer/misc/api/odoo.rst developer/misc/api/external_api.rst +developer/misc/api/external_api.rst developer/api/external_api.rst # better location for misc/ content (#2350) # legal