[ADD] general: add documentation about debug mode

This commit is contained in:
keli brugalli (kbr) 2020-03-03 14:32:55 +01:00 committed by Antoine Vandevenne (anv)
parent 74c3734251
commit dfc585d25f
36 changed files with 124 additions and 90 deletions

View File

@ -121,8 +121,8 @@ database, please `submit a support ticket <https://www.odoo.com/help>`_.
How can I update my bank credentials?
-------------------------------------
You can update your credentials in the *Developer Mode*.
You can update your credentials on
:doc:`Developer mode <../../../general/developer_mode/activate>`.
To do so, go to :menuselection:`General Settings`, click on *Activate developer mode*, then go to
:menuselection:`Accounting --> Configuration --> Online Synchronization`, then open the Institution
you want to edit, and click on *Update Credentials*.
Then go to :menuselection:`Accounting --> Configuration --> Online Synchronization`, and open the
Institution you want to edit, and click on *Update Credentials*.

View File

@ -135,8 +135,8 @@ Journals
Once the DIAN has assigned the official sequence and prefix for the
electronic invoice resolution, the Sales journals related to your
invoice documents need to be updated in Odoo. The sequence can be
accessed using developer mode: :menuselection:`Accounting --> Settings
--> Configuration Setting --> Journals`.
accessed using the :doc:`Developer mode <../../general/developer_mode/activate>`: :menuselection:`Accounting -->
Settings --> Configuration Setting --> Journals`.
.. image:: media/colombia09.png
:align: center

View File

@ -74,7 +74,7 @@ To get the certification just follow the following steps:
.. note::
* To install the module in any system created before
December 18th 2017, you should update the modules list.
To do so, activate the developer mode from the *Settings* menu.
To do so, activate the :doc:`Developer mode <../../general/developer_mode/activate>`.
Then go to the *Apps* menu and press *Update Modules List* in the top-menu.
* In case you run Odoo on-premise, you need to update your installation
and restart your server beforehand.
@ -156,9 +156,8 @@ Invoicing and Accounting apps.
it will be counted in the very next closing.
.. tip:: For test & audit purposes such closings can be manually generated in the
developer mode. Go to
:menuselection:`Settings --> Technical --> Automation --> Scheduled Actions`
to do so.
:doc:`Developer mode <../../general/developer_mode/activate>`. Then go to
:menuselection:`Settings --> Technical --> Automation --> Scheduled Actions`.
Responsibilities

View File

@ -106,10 +106,7 @@ Enabling CFDI Version 3.3
SaaS instance please ask for an upgrade by submitting a ticket to support in
https://www.odoo.com/help.
Enable debug mode:
.. image:: media/mexico10.png
:align: center
Enable the :doc:`Developer mode <../../general/developer_mode/activate>`.
Go and look the following technical parameter, on
:menuselection:`Settings --> Technical --> Parameters --> System Parameters`
@ -544,8 +541,8 @@ Enabling Explicit errors on the CFDI using the XSD local validator (CFDI 3.3)
Frequently you want receive explicit errors from the fields incorrectly set
on the xml, those errors are better informed to the user if the check is
enable, to enable the Check with xsd feature follow the next steps (with
debug mode enabled).
enable, to enable the Check with xsd feature follow the next steps (with the
:doc:`Developer mode <../../general/developer_mode/activate>` enabled).
- Go to :menuselection:`Settings --> Technical --> Actions --> Server Actions`
- Look for the Action called "Download XSD files to CFDI"

View File

@ -14,16 +14,7 @@ Activate the developer mode
===========================
In order to have access to the financial report creation interface, the
**developer mode** needs to be activated. To do that, first click on the
user profile in the top right menu, then **About**.
.. image:: media/customize01.png
:align: center
Click on : **Activate the developer mode**.
.. image:: media/customize03.png
:align: center
:doc:`Developer mode <../../../general/developer_mode/activate>` needs to be activated.
Create your financial report
============================

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

View File

@ -159,22 +159,18 @@ alias in your mail server.
email server (e.g. *catchall@mydomain.ext* to *catchall@mycompany.odoo.com*).
.. tip:: All the aliases are customizable in Odoo.
Object aliases can be edited from their respective configuration view.
To edit catchall and bounce aliases, you first need to activate the
developer mode from the Settings Dashboard.
Object aliases can be edited from their respective configuration view.
To edit catchall and bounce aliases, you first need to activate the
:doc:`Developer mode <../../general/developer_mode/activate>`.
.. image:: media/developer_mode.png
:align: center
Then refresh your screen and go to
:menuselection:`Settings --> Technical --> Parameters --> System Parameters`
Then go to :menuselection:`Settings --> Technical --> Parameters --> System Parameters`
to customize the aliases (*mail.catchall.alias* & * mail.bounce.alias*).
.. image:: media/system_parameters.png
:align: center
.. note:: By default inbound messages are fetched every 5 minutes in Odoo on-premise.
You can change this value in developer mode.
You can change this value in :doc:`Developer mode <../../general/developer_mode/activate>`.
Go to :menuselection:`Settings --> Technical --> Automation -->
Scheduled Actions` and look for *Mail: Fetchmail Service*.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

View File

@ -84,7 +84,7 @@ So you will confirm orders manually once you get paid.
How to:
* Switch to developer mode.
* Switch to :doc:`Developer mode <../../../general/developer_mode/activate>`.
* Take the **Custom** payment method.

View File

@ -12,3 +12,4 @@ General
general/base_import
general/auth
general/in_app_purchase
general/developer_mode

View File

@ -0,0 +1,8 @@
==============
Developer Mode
==============
.. toctree::
:titlesonly:
developer_mode/activate

View File

@ -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 odoos debug icon in a chromes 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

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

View File

@ -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

View File

@ -37,12 +37,7 @@ randomly, balanced, or manually.
How to set up different stages for each team
--------------------------------------------
First you will need to activate the developer mode. To do this go to
your settings module, and select the link for "Activate the developer
mode" on the lower right-hand side.
.. image:: media/helpdesk04.png
:align: center
First you will need to activate the :doc:`Developer mode <../../general/developer_mode/activate>`.
Now, when you return to your Helpdesk module and select "Configuration"
in the purple bar you will find additional options, like "Stages". Here

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

View File

@ -13,8 +13,8 @@ Create a Barcode Nomenclature
=============================
Odoo supports Barcode Nomenclatures, which determine the mapping and
interpretation of the encoded information.
You can configure your barcode nomenclature being in **debug** mode.
interpretation of the encoded information. You can configure your barcode nomenclature being in
:doc:`Developer mode <../../../general/developer_mode/activate>`.
To do so, go to :menuselection:`Inventory --> Configuration --> Barcode Nomenclature`.
You can create a barcode nomenclature from there, and then add a line to

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.6 KiB

View File

@ -44,11 +44,8 @@ production orders, deliveries and supplier purchases.
Configure and run the scheduler (for advanced users)
----------------------------------------------------
To use this feature, you have to enable the debug mode. To do so, go to
:menuselection:`Settings --> Activate the developer mode`.
.. image:: media/schedulers_02.png
:align: center
To use this feature, you have to enable the
:doc:`Developer mode <../../../general/developer_mode/activate>` mode.
Then, go to :menuselection:`Settings --> Technical --> Automation --> Scheduled Actions`
and modify the *Run MRP Scheduler Configuration*. There, you can set

View File

@ -182,7 +182,8 @@ accounting modes.
Usually, based on your country, the correct accounting mode will be
chosen by default. If you want to verify your accounting mode, activate
the developer mode and open your accounting settings.
the :doc:`Developer mode <../../../general/developer_mode/activate>` and open your accounting
settings.
Manual Inventory Valuation
--------------------------

View File

@ -150,7 +150,8 @@ Check your outgoing email servers
There is a default mail server provided with Odoo.sh.
To use it, there must be no enabled outgoing mail server configured in your database in
:menuselection:`Settings --> Technical --> Outgoing Mail Servers` (Developer mode must be activated).
:menuselection:`Settings --> Technical --> Outgoing Mail Servers`
(:doc:`Developer mode <../../general/developer_mode/activate>` must be activated).
After the import of your database,
all outgoing email servers are disabled so you use the Odoo.sh email server provided by default.

View File

@ -265,11 +265,7 @@ and on your production you would not like your module to be installed automatica
Your module may not appear directly in your apps to install either, you need to update your apps list first:
* activate the developer mode from the Settings,
.. image:: ./media/firstmodule-test-developermode.png
:align: center
* activate the :doc:`Developer mode <../../general/developer_mode/activate>`
* in the apps menu, click the *Update Apps List* button,
* in the dialog that appears, click the *Update* button.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

View File

@ -24,15 +24,10 @@ To install Mercury go to :menuselection:`Apps` and search for the
Configuration
=============
To configure mercury, you need to activate the developer mode. To do so
go to :menuselection:`Apps --> Settings` and select *Activate the
developer mode*.
To configure mercury, you need to activate the
:doc:`Developer mode <../../general/developer_mode/activate>`.
.. image:: media/mercury02.png
:align: center
While in developer mode, go to :menuselection:`Point of Sale -->
Configuration --> Mercury Configurations`.
Now, go to :menuselection:`Point of Sale --> Configuration --> Mercury Configurations`.
Create a new configuration for credit cards and enter your Mercury
credentials.

View File

@ -25,14 +25,16 @@ Seller Central and notify the customer.
.. note::
To force the synchronization of an order whose status has not changed since the last
synchronization, activate the **Developer mode**, navigate to your Amazon account and modify the
date under :menuselection:`Orders Follow-up --> Last Order Sync`. Pick a date anterior to the
last status change of the order that you wish to synchronize and save.
synchronization, activate the :doc:`Developer mode <../../general/developer_mode/activate>`,
navigate to your Amazon account and modify the date under
:menuselection:`Orders Follow-up --> Last Order Sync`. Pick a date anterior to the last status
change of the order that you wish to synchronize and save.
.. tip::
To synchronize immediately the orders of your Amazon account switch to **Developer mode**, head
to your Amazon account and click the button **SYNC ORDERS**. The same can be done with order
cancellations and pickings by clicking the buttons **SYNC CANCELLATIONS** and **SYNC PICKINGS**.
To synchronize immediately the orders of your Amazon account switch to
:doc:`Developer mode <../../general/developer_mode/activate>`, head to your Amazon account and click on
**SYNC ORDERS**. The same can be done with order cancellations and pickings by clicking
on **SYNC CANCELLATIONS** and **SYNC PICKINGS**.
Manage deliveries in FBM
========================

View File

@ -46,7 +46,8 @@ code, a default database product **Amazon Sale** is used. The same is done with
**Amazon Shipping** and the shipping code.
.. note::
To modify the default products, activate the **Developer mode** and navigate to
To modify the default products, activate the
:doc:`Developer mode <../../general/developer_mode/activate>` and navigate to
:menuselection:`Sales --> Configuration --> Settings --> Connectors --> Amazon Sync -->
Default Products`.

View File

@ -48,7 +48,7 @@ parallel in existing installations.
To switch to the new synchronization mechanism:
#. Enable the Developper Mode by going to :menuselection:`Settings --> Activate the developer mode`
#. Enable the :doc:`Developer mode <../../general/developer_mode/activate>`.
#. Go to :menuselection:`Settings --> Technical --> Scheduled Actions`
#. Archive the old synchronization actions (both are named *Ebay: update product status*)
#. Activate the new synchronization actions (*Ebay: get new orders* which runs every 15min by default and *Ebay: synchronise stock (for 'get new orders' synchronisation)* which runs once a day per default)

View File

@ -45,8 +45,9 @@ If you would like to send a message in a batch here, you could go to
Set up SMS Templates
====================
To set up *SMS Templates*, go to the *Settings* app and activate the *developer mode*. Now,
go to :menuselection:`Technical --> Phone/SMS section --> SMS Templates`.
To set up *SMS Templates*, activate
the :doc:`Developer mode <../../general/developer_mode/activate>`. Now, go to
:menuselection:`Technical --> Phone/SMS section --> SMS Templates`.
.. image:: ./media/sms_marketing17.png
:align: center

View File

@ -99,8 +99,9 @@ More common questions
#. **Do I have a history of the sent SMSs?**
Yes, the SMS is logged as a note under the chatter of the corresponding record, and a complete
history of SMS sent is available under :menuselection:`Settings --> Activate the developer mode
--> Technical --> SMS`.
history of the SMSs sent is available on
:doc:`Developer mode <../../general/developer_mode/activate>` under
:menuselection:`Technical --> SMS`.
#. **Can I send as many SMSs I want at once?**

View File

@ -92,8 +92,8 @@ Configure your own Facebook and Twitter developer accounts
By default, the Social application is already configured with a Facebook
and Twitter developer accounts but you can use your own if necessary.
Activate the developer mode, go to :menuselection:`Configuration --> Settings` and enter
your own API keys.
Activate the :doc:`Developer mode <../../general/developer_mode/activate>`, and enter your
own API keys.
.. image:: media/social_marketing05.png
:align: center

View File

@ -480,10 +480,10 @@ page. As these files are shared across all pages, further clicks by the
same visitor will not load any other Javascript resource.
.. note::
If you work in debug mode, the CSS and Javascript are neither
concatenated, nor minified. Thus, it's much slower. But it allows you to
easily debug with the Chrome debugger as CSS and Javascript resources
are not transformed from their original versions.
If you work on :doc:`Developer mode <../../general/developer_mode/activate>`, the CSS and
Javascript are neither concatenated, nor minified. Thus, it's much slower. But it allows you to
easily debug with the Chrome debugger as CSS and Javascript resources are not transformed from
their original versions.
CDN
---
@ -638,8 +638,7 @@ It means that all robots are allowed to index your website
and there is no other indexing rule than specified in the sitemap
to be found at following address.
You can customize the file *robots* in developer mode from
*Settings --> Technical --> User Interface --> Views*
(exclude robots, exclude some pages, redirect to a custom Sitemap).
Make the Model Data of the view *Non Updatable* to not reset the
file after system upgrades.
You can customize the file *robots* in
:doc:`Developer mode <../../general/developer_mode/activate>` from *Settings --> Technical -->
User Interface --> Views* (exclude robots, exclude some pages, redirect to a custom Sitemap).
Make the Model Data of the view *Non Updatable* to not reset the file after system upgrades.