[MOV] documentation structure reorganization

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 closes odoo/documentation#8063 Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-03-04 12:02:08 +01:00
parent af91b7c2b6
commit bf7fa31503
562 changed files with 644 additions and 643 deletions
@@ -0,0 +1,165 @@
+============
+Gmail Plugin
+============
+
+The *Gmail Plugin* integrates an Odoo database with a Gmail inbox, so users can keep track of all
+their work between Gmail and Odoo, without losing any information.
+
+Odoo Online users
+=================
+
+For databases hosted on Odoo Online (or Odoo.sh), follow the steps below to configure the Gmail
+Plugin.
+
+Install the Gmail Plugin
+------------------------
+
+First, log in to the Gmail account that the user wishes to connect to Odoo.
+
+From the Gmail inbox, click the plus sign icon on the right side panel to get add-ons. If the side
+panel is not visible, click on the arrow icon at the bottom right corner of the inbox to reveal it.
+
+.. image:: gmail/gmail-side-panel.png
+   :align: center
+   :alt: Plus sign icon on the Gmail inbox side panel.
+
+Then, use the search bar to search for `Odoo` and locate the :guilabel:`Odoo Inbox Addin`.
+
+.. image:: gmail/google-workspace-marketplace.png
+   :align: center
+   :alt: Odoo Inbox Addin on Google Workspace Marketplace.
+
+Or, go directly to the :guilabel:`Odoo Inbox Addin` page on the `Google Workspace Marketplace
+<https://workspace.google.com/marketplace/app/odoo_inbox_addin/873497133275>`_.
+
+Once the plugin is located, click :guilabel:`Install`. Then, click :guilabel:`Continue` to start
+the installation.
+
+Next, select which Gmail account the user wishes to connect to Odoo. Then click :guilabel:`Allow`
+to let Odoo access the Google account. Google will then show a pop-up window confirming that the
+installation was successful.
+
+Configure the Odoo database
+---------------------------
+
+The :guilabel:`Mail Plugin` feature must be enabled in the Odoo database in order to use the Gmail
+Plugin. To enable the feature, go to :menuselection:`Settings --> General Settings`. Under the
+:guilabel:`Integrations` section, activate :guilabel:`Mail Plugin`, and then click
+:guilabel:`Save`.
+
+.. image:: gmail/mail-plugin-setting.png
+   :align: center
+   :alt: The Mail Plugin feature in the Settings.
+
+Configure the Gmail inbox
+-------------------------
+
+In the Gmail inbox, a purple Odoo icon is now visible on the right side panel. Click on the Odoo
+icon to open up the Odoo plugin window. Then, click on any email in the inbox. Click
+:guilabel:`Authorize Access` in the plugin window to grant Odoo access to the Gmail inbox.
+
+.. image:: gmail/authorize-access.png
+   :align: center
+   :alt: The Authorize Access button in the right sidebar of the Odoo plugin panel.
+
+Next, click :guilabel:`Login`. Then, enter the URL of the Odoo database that the user wishes to
+connect to the Gmail inbox, and log in to the database.
+
+.. note::
+   Use the general URL for the database, not the URL of a specific page in the database. For
+   example, use `https://mycompany.odoo.com`, not
+   `https://mycompany.odoo.com/web#cids=1&action=menu`.
+
+Finally, click :guilabel:`Allow` to let Gmail access the Odoo database. The browser will then show
+a :guilabel:`Success!` message. After that, close the window. The Gmail inbox and Odoo database are
+now connected.
+
+Odoo On-Premise users
+=====================
+
+For databases hosted on servers other than Odoo Online (or Odoo.sh), follow the steps below to
+configure the Gmail Plugin.
+
+.. note::
+   As part of their security guidelines, Google requires add-on creators to provide a list of URLs
+   that can be used in actions and redirections launched by the add-on. This protects users by
+   ensuring, for example, that no add-on redirects users toward a malicious website. (Read more on
+   `Google Apps Script <https://developers.google.com/apps-script/manifest/allowlist-url>`_.)
+
+   Since Odoo can only list the `odoo.com` domain and not every on-premise customer's unique server
+   domain, on-premise customers cannot install the Gmail Plugin from the Google Workspace
+   Marketplace.
+
+Install the Gmail Plugin
+------------------------
+
+First, access the `GitHub repository <https://github.com/odoo/mail-client-extensions>`_ for the
+Odoo Mail Plugins. Next, click on the green :guilabel:`Code` button. Then, click
+:guilabel:`Download ZIP` to download the Mail Plugin files onto the user's computer.
+
+.. image:: gmail/gh-download-zip.png
+   :align: center
+   :alt: Download the ZIP file from the Odoo GitHub repository for Mail Plugins.
+
+Open the ZIP file on the computer. Then, go to :menuselection:`mail-client-extensions-master -->
+gmail --> src --> views`, and open the :file:`login.ts` file using any text editor software,
+such as Notepad (Windows), TextEdit (Mac), or Visual Studio Code.
+
+Delete the following three lines of text from the :file:`login.ts` file:
+
+.. code-block::
+
+   if (!/^https:\/\/([^\/?]*\.)?odoo\.com(\/|$)/.test(validatedUrl)) {
+        return notify("The URL must be a subdomain of odoo.com");
+   }
+
+This removes the `odoo.com` domain constraint from the Gmail Plugin program.
+
+Next, in the ZIP file, go to :menuselection:`mail-client-extensions-master --> gmail`, and open the
+file called :guilabel:`appsscript.json`. In the :guilabel:`urlFetchWhitelist` section, replace all
+the references to `odoo.com` with the Odoo customer's unique server domain.
+
+Then, in the same :guilabel:`gmail` folder, open the file called :guilabel:`README.md`. Follow the
+instructions in the :guilabel:`README.md` file to push the Gmail Plugin files as a Google Project.
+
+.. note::
+   The computer must be able to run Linux commands in order to follow the instructions on the
+   :guilabel:`README.md` file.
+
+After that, share the Google Project with the Gmail account that the user wishes to connect to Odoo.
+Then, click :guilabel:`Publish` and :guilabel:`Deploy from manifest`. Lastly, click
+:guilabel:`Install the add-on` to install the Gmail Plugin.
+
+Configure the Odoo database
+---------------------------
+
+The :guilabel:`Mail Plugin` feature must be enabled in the Odoo database in order to use the Gmail
+Plugin. To enable the feature, go to :menuselection:`Settings --> General Settings`. Under the
+:guilabel:`Integrations` section, activate :guilabel:`Mail Plugin`, and then click :guilabel:`Save`.
+
+.. image:: gmail/mail-plugin-setting.png
+   :align: center
+   :alt: The Mail Plugin feature in the Settings.
+
+Configure the Gmail inbox
+-------------------------
+
+In the Gmail inbox, a purple Odoo icon is now visible on the right side panel. Click on the Odoo
+icon to open up the Odoo plugin window. Then, click on any email in the inbox. Click
+:guilabel:`Authorize Access` in the plugin window to grant Odoo access to the Gmail inbox.
+
+.. image:: gmail/authorize-access.png
+   :align: center
+   :alt: The Authorize Access button in the right sidebar of the Odoo plugin panel.
+
+Next, click :guilabel:`Login`. Then, enter the URL of the Odoo database that the user wishes to
+connect to the Gmail inbox, and log in to the database.
+
+.. note::
+   Use the general URL for the database, not the URL of a specific page in the database. For
+   example, use `https://mycompany.odoo.com`, not
+   `https://mycompany.odoo.com/web#cids=1&action=menu`.
+
+Finally, click :guilabel:`Allow` to let Gmail access the Odoo database. The browser will then show
+a :guilabel:`Success!` message. After that, close the window. The Gmail inbox and Odoo database are
+now connected.
@@ -0,0 +1,150 @@
+==============
+Outlook Plugin
+==============
+
+Outlook allows for third-party applications to connect in order to execute database actions from
+emails. Odoo has a plugin for Outlook that allows for the creation of an opportunity from the email
+panel.
+
+Configuration
+=============
+
+The Outlook :doc:`Mail Plugin <../mail_plugins>` needs to be configured both on Odoo and Outlook.
+
+.. _mail-plugin/outlook/enable-mail-plugin:
+
+Enable Mail Plugin
+------------------
+
+First, enable the *Mail Plugin* feature in the database. Go to :menuselection:`Settings --> General
+Settings --> Integrations`, enable :guilabel:`Mail Plugin`, and :guilabel:`Save` the configuration.
+
+.. _mail-plugin/outlook/install-plugin:
+
+Install the Outlook Plugin
+--------------------------
+
+Download (:menuselection:`Save Page As --> Web Page XML only`) the following XML file to upload
+later: `https://download.odoocdn.com/plugins/outlook/manifest.xml
+<https://download.odoocdn.com/plugins/outlook/manifest.xml>`_.
+
+Next, open the Outlook mailbox, and select any email. After completing this, click on the
+:guilabel:`More actions` button in the upper right-side and select :guilabel:`Get Add-ins`.
+
+.. image:: outlook/more-actions.png
+   :align: center
+   :alt: More actions button in Outlook
+
+Following this step, select the :guilabel:`My add-ins` tab on the left-side.
+
+.. image:: outlook/my-add-ins.png
+   :align: center
+   :alt: My add-ins in Outlook
+
+Under :guilabel:`Custom add-ins` towards the bottom, click on :guilabel:`+ Add a custom add-in`, and
+then on :guilabel:`Add from file...`
+
+.. image:: outlook/custom-add-ins.png
+   :align: center
+   :alt: Custom add-ins in Outlook
+
+For the next step, attach the `manifest.xml` file downloaded above, and press :guilabel:`OK`. Next,
+read the warning and click on :guilabel:`Install`.
+
+.. image:: outlook/add-in-warning.png
+   :align: center
+   :alt: Custom add-in installation warning in Outlook
+
+.. _mail-plugin/outlook/connect-database:
+
+Connect the database
+--------------------
+
+Now, Outlook will be connected to the Odoo database. First, open any email in the Outlook mailbox,
+click on the :guilabel:`More actions` button in the upper right-side, and select :guilabel:`Odoo for
+Outlook`.
+
+.. image:: outlook/odoo-for-outlook.png
+   :align: center
+   :alt: Odoo for Outlook add-in button
+
+The right-side panel can now display **Company Insights**. At the bottom, click on
+:guilabel:`Login`.
+
+.. image:: outlook/panel-login.png
+   :align: center
+   :alt: Logging in the Odoo database
+
+.. note::
+   Only a limited amount of **Company Insights** (*Lead Enrichment*) requests are available as a
+   trial database. This feature requires :ref:`prepaid credits <mail_plugins/pricing>`.
+
+.. tip::
+   If, after a short while, the panel is still empty, it is possible that the browser cookie
+   settings prevented it from loading. Note that these settings also change if the browser is in
+   "Incognito" mode.
+
+   To fix this issue, configure the browser to always allow cookies on Odoo's plugin page.
+
+   For Google Chrome, change the browser cookie settings by following the guide at:
+   `https://support.google.com/chrome/answer/95647
+   <https://support.google.com/chrome/answer/95647>`_
+   and adding `download.odoo.com` to the list of :guilabel:`Sites that can always use cookies`.
+
+   Once this is complete, the Outlook panel needs to be opened again.
+
+Now, enter the Odoo database URL and click on :guilabel:`Login`.
+
+.. image:: outlook/enter-database-url.png
+   :align: center
+   :alt: Entering the Odoo database URL
+
+Next, click on :guilabel:`Allow` to open the pop-up window.
+
+.. image:: outlook/new-window-warning.png
+   :align: center
+   :alt: New window pop-up warning
+
+If the user isn't logged into the database, enter the credentials. Click on :guilabel:`Allow` to let
+the Outlook Plugin connect to the database.
+
+.. image:: outlook/odoo-permission.png
+   :align: center
+   :alt: Allowing the Outlook Plugin to connect to a database
+
+.. _mail-plugin/outlook/add-shortcut:
+
+Add a shortcut to the plugin
+----------------------------
+
+By default, the Outlook Plugin can be opened from the *More actions* menu. However, to save time,
+it's possible to add it next to the other default actions.
+
+In the Outlook mailbox, click on :guilabel:`Settings`, then on :guilabel:`View all Outlook
+settings`.
+
+.. image:: outlook/all-outlook-settings.png
+   :align: center
+   :alt: Viewing all Outlook settings
+
+Now, select :guilabel:`Customize actions` under :guilabel:`Mail`, click on :guilabel:`Odoo for
+Outlook`, and then :guilabel:`Save`.
+
+.. image:: outlook/customize-actions.png
+   :align: center
+   :alt: Odoo for Outlook customized action
+
+Following this step, open any email; the shortcut should be displayed.
+
+.. image:: outlook/odoo-outlook-shortcut.png
+   :align: center
+   :alt: Odoo for Outlook customized action
+
+Using the plugin
+----------------
+
+Now that the plug-in is installed and operational, all that needs to be done to create a lead is to
+click on the `O` [Odoo icon] or navigate to :guilabel:`More actions` and click on :guilabel:`Odoo
+for Outlook`. The side panel will appear on the right-side, and under :guilabel:`Opportunities`
+click on :guilabel:`New`. A new window with the created opportunity in the Odoo database will
+populate.