[ADD] general: add documentation about debug mode

2020-03-03 14:32:55 +01:00
parent 74c3734251
commit dfc585d25f
36 changed files with 124 additions and 90 deletions
@@ -0,0 +1,8 @@
+==============
+Developer Mode
+==============
+
+.. toctree::
+   :titlesonly:
+
+   developer_mode/activate
@@ -0,0 +1,53 @@
+===================================
+Activate the Developer (Debug) Mode
+===================================
+
+The Developer or Debug Mode gives you access to extra and advanced tools.
+
+Through the Settings application
+--------------------------------
+
+Go to :menuselection:`Settings --> Activate the developer mode`.
+
+.. image:: media/settingsdebug.png
+   :align: center
+   :alt: Overview of the debug options under settings in Odoo
+
+.. note::
+   *Activate the developer mode (with assets)* is used by developers; *Activate the developer mode
+   (with tests assets)* is used by developers and testers.
+
+Once activated, the *Deactivate the developer mode* option becomes available.
+
+Through a browser extension
+---------------------------
+
+| Go to the settings and extensions of your web browser, and search for *Odoo Debug*. Once the
+  extension is installed, a new icon will be shown on your toolbar.
+| A single click enables a normal version of the mode, while a double click enables it with assets.
+| To deactivate it, use a single click.
+
+.. image:: media/monkey.png
+   :align: center
+   :alt: View of odoo’s debug icon in a chrome’s toolbar
+
+.. tip::
+   Developers: type ``?debug=assets`` and activate the mode with assets.
+
+Through the URL
+---------------
+
+On the URL add ``?debug=1`` or ``?debug=trueafter`` after *web*.
+
+.. image:: media/url.png
+   :align: center
+   :alt: Overview of an url with the debug mode command added in Odoo
+
+Locate the mode tools
+---------------------
+
+The bug icon, *Open Developer Tools*, can be found on the header of your pages.
+
+.. image:: media/bugicon.png
+   :align: center
+   :alt: Overview of a console page and the debug icon being shown in Odoo
@@ -24,8 +24,8 @@ IAP accounts

 Credits to use IAP services are stored on IAP accounts, which are specific to each service and
 database. By default, IAP accounts are common to all companies, but can be restricted to specific
-ones by going to :menuselection:`Settings app --> Activate the Developer Mode --> Technical Settings
--> IAP Account`.
+ones. Activate the :doc:`Developer mode <../../general/developer_mode/activate>`, then go to
+:menuselection:`Technical Settings --> IAP Account`.

 .. image:: media/image2.png
   :align: center