From 3d2c5d7c162342fb0b5d1f16b84c2d11efacf423 Mon Sep 17 00:00:00 2001 From: "Jonathan Castillo (jcs)" Date: Wed, 5 Apr 2023 10:10:24 +0000 Subject: [PATCH] [MOV] calendar: "Calendar" app from "Misc" to "Productivity" To improve the structure of the documentation, the "Miscellaneous" section should be limited as much as possible. This commit: - renames "Calendars" into "Calendar" (as the app name) - moves the app from the "Miscellaneous" section to the "Productivity" section - fixes the wrong file structure to follow the toc (e.g. general/calendars/outlook/outlook_calendar -> productivity/calendar/outlook) task-3217827 closes odoo/documentation#4123 Signed-off-by: Castillo Jonathan (jcs) --- .../administration/maintain/azure_oauth.rst | 2 +- .../administration/maintain/google_oauth.rst | 2 +- content/applications/general.rst | 1 - content/applications/general/auth/azure.rst | 2 +- content/applications/general/auth/google.rst | 2 +- content/applications/general/calendars.rst | 11 -------- content/applications/productivity.rst | 1 + .../applications/productivity/calendar.rst | 11 ++++++++ .../calendar/google.rst} | 26 +++++++++--------- .../calendar/google}/credential-type.png | Bin .../calendar/google}/edit-oauth-2.png | Bin .../calendar/google}/enable-apis-services.png | Bin .../google}/enable-google-cal-api.png | Bin .../calendar/google}/new-api-project.png | Bin .../calendar/google}/settings-google-cal.png | Bin .../calendar/google}/successful-sync.png | Bin .../calendar/google}/sync-google.png | Bin .../calendar/google}/trust-odoo.png | Bin .../calendar/google}/uri.png | Bin .../calendar/outlook.rst} | 24 ++++++++-------- .../outlook}/azure-register-application.png | Bin .../calendar/outlook}/client-id.png | Bin .../calendar/outlook}/client-secret-value.png | Bin .../outlook}/outlook-calendar-setting.png | Bin .../calendar/outlook}/outlook-sync-button.png | Bin .../calendar/outlook}/redirect-uri.png | Bin redirects/14.0.txt | 5 ++++ 27 files changed, 46 insertions(+), 41 deletions(-) delete mode 100644 content/applications/general/calendars.rst create mode 100644 content/applications/productivity/calendar.rst rename content/applications/{general/calendars/google/google_calendar_credentials.rst => productivity/calendar/google.rst} (88%) rename content/applications/{general/calendars/google/google_calendar_credentials => productivity/calendar/google}/credential-type.png (100%) rename content/applications/{general/calendars/google/google_calendar_credentials => productivity/calendar/google}/edit-oauth-2.png (100%) rename content/applications/{general/calendars/google/google_calendar_credentials => productivity/calendar/google}/enable-apis-services.png (100%) rename content/applications/{general/calendars/google/google_calendar_credentials => productivity/calendar/google}/enable-google-cal-api.png (100%) rename content/applications/{general/calendars/google/google_calendar_credentials => productivity/calendar/google}/new-api-project.png (100%) rename content/applications/{general/calendars/google/google_calendar_credentials => productivity/calendar/google}/settings-google-cal.png (100%) rename content/applications/{general/calendars/google/google_calendar_credentials => productivity/calendar/google}/successful-sync.png (100%) rename content/applications/{general/calendars/google/google_calendar_credentials => productivity/calendar/google}/sync-google.png (100%) rename content/applications/{general/calendars/google/google_calendar_credentials => productivity/calendar/google}/trust-odoo.png (100%) rename content/applications/{general/calendars/google/google_calendar_credentials => productivity/calendar/google}/uri.png (100%) rename content/applications/{general/calendars/outlook/outlook_calendar.rst => productivity/calendar/outlook.rst} (91%) rename content/applications/{general/calendars/outlook/outlook_calendar => productivity/calendar/outlook}/azure-register-application.png (100%) rename content/applications/{general/calendars/outlook/outlook_calendar => productivity/calendar/outlook}/client-id.png (100%) rename content/applications/{general/calendars/outlook/outlook_calendar => productivity/calendar/outlook}/client-secret-value.png (100%) rename content/applications/{general/calendars/outlook/outlook_calendar => productivity/calendar/outlook}/outlook-calendar-setting.png (100%) rename content/applications/{general/calendars/outlook/outlook_calendar => productivity/calendar/outlook}/outlook-sync-button.png (100%) rename content/applications/{general/calendars/outlook/outlook_calendar => productivity/calendar/outlook}/redirect-uri.png (100%) diff --git a/content/administration/maintain/azure_oauth.rst b/content/administration/maintain/azure_oauth.rst index e144e4704..fe9402379 100644 --- a/content/administration/maintain/azure_oauth.rst +++ b/content/administration/maintain/azure_oauth.rst @@ -13,7 +13,7 @@ personal email address or an address created by a custom domain. .. seealso:: - :doc:`/applications/general/auth/azure` - - :doc:`/applications/general/calendars/outlook/outlook_calendar` + - :doc:`/applications/productivity/calendar/outlook` Setup in Microsoft Azure Portal =============================== diff --git a/content/administration/maintain/google_oauth.rst b/content/administration/maintain/google_oauth.rst index ced3b5b52..d2c3616fe 100644 --- a/content/administration/maintain/google_oauth.rst +++ b/content/administration/maintain/google_oauth.rst @@ -13,7 +13,7 @@ email address or an address created by a custom domain. .. seealso:: - :doc:`/applications/general/auth/google` - - :doc:`/applications/general/calendars/google/google_calendar_credentials` + - :doc:`/applications/productivity/calendar/google` Setup in Google =============== diff --git a/content/applications/general.rst b/content/applications/general.rst index 8d0e0726c..e8a9a7eba 100644 --- a/content/applications/general.rst +++ b/content/applications/general.rst @@ -12,7 +12,6 @@ Miscellaneous general/reporting general/email_communication general/voip - general/calendars general/digest_emails general/in_app_purchase general/developer_mode diff --git a/content/applications/general/auth/azure.rst b/content/applications/general/auth/azure.rst index 68156e64b..82d1470d2 100644 --- a/content/applications/general/auth/azure.rst +++ b/content/applications/general/auth/azure.rst @@ -6,5 +6,5 @@ Due to specific requirements in Azure's OAuth implementation, Microsoft Azure OA is NOT compatible with Odoo at the moment. .. seealso:: - - :doc:`/applications/general/calendars/outlook/outlook_calendar` + - :doc:`../../productivity/calendar/outlook` - :doc:`/administration/maintain/azure_oauth` diff --git a/content/applications/general/auth/google.rst b/content/applications/general/auth/google.rst index b3efe89c2..f13c6f279 100644 --- a/content/applications/general/auth/google.rst +++ b/content/applications/general/auth/google.rst @@ -9,7 +9,7 @@ This is particularly helpful if your organization uses Google Workforce and you within your organization to connect to Odoo with their Google Accounts. .. seealso:: - - :doc:`/applications/general/calendars/google/google_calendar_credentials` + - :doc:`../../productivity/calendar/google` - :doc:`/administration/maintain/google_oauth` .. _google-sign-in/configuration: diff --git a/content/applications/general/calendars.rst b/content/applications/general/calendars.rst deleted file mode 100644 index a427656f2..000000000 --- a/content/applications/general/calendars.rst +++ /dev/null @@ -1,11 +0,0 @@ -:nosearch: - -========= -Calendars -========= - -.. toctree:: - :titlesonly: - - calendars/outlook/outlook_calendar - calendars/google/google_calendar_credentials diff --git a/content/applications/productivity.rst b/content/applications/productivity.rst index 415752c84..ac15d3f31 100644 --- a/content/applications/productivity.rst +++ b/content/applications/productivity.rst @@ -8,6 +8,7 @@ Productivity .. toctree:: productivity/discuss + productivity/calendar productivity/knowledge productivity/iot productivity/mail_plugins diff --git a/content/applications/productivity/calendar.rst b/content/applications/productivity/calendar.rst new file mode 100644 index 000000000..6fbf6b454 --- /dev/null +++ b/content/applications/productivity/calendar.rst @@ -0,0 +1,11 @@ +:nosearch: + +======== +Calendar +======== + +.. toctree:: + :titlesonly: + + calendar/outlook + calendar/google diff --git a/content/applications/general/calendars/google/google_calendar_credentials.rst b/content/applications/productivity/calendar/google.rst similarity index 88% rename from content/applications/general/calendars/google/google_calendar_credentials.rst rename to content/applications/productivity/calendar/google.rst index 16ad8f3e1..8e052763e 100644 --- a/content/applications/general/calendars/google/google_calendar_credentials.rst +++ b/content/applications/productivity/calendar/google.rst @@ -1,6 +1,6 @@ -===================================== -Synchronize Google Calendar with Odoo -===================================== +=============================== +Google Calendar synchronization +=============================== Synchronize Google Calendar with Odoo to see and manage meetings from both platforms (updates go in both directions). This integration helps organize your schedule so you never miss a meeting. @@ -25,7 +25,7 @@ Begin by creating a new Google API project and enabling the Google Calendar API. Next, click :guilabel:`Select a project` and select or create an API project to store credentials. -.. image:: google_calendar_credentials/new-api-project.png +.. image:: google/new-api-project.png :align: center :alt: Create a new API project to store credentials. @@ -34,14 +34,14 @@ Next, click :guilabel:`Select a project` and select or create an API project to Then, open the API Project and click :guilabel:`Enable APIs and Services`. -.. image:: google_calendar_credentials/enable-apis-services.png +.. image:: google/enable-apis-services.png :align: center :alt: Enable APIs and Services on the API Project. After that, search for *Google Calendar API* using the search bar and select :guilabel:`Google Calendar API` from the search results. Click :guilabel:`Enable`. -.. image:: google_calendar_credentials/enable-google-cal-api.png +.. image:: google/enable-google-cal-api.png :align: center :alt: Enable the Google Calendar API. @@ -55,7 +55,7 @@ four steps to create your API credentials. - In the first step, :guilabel:`Credential Type`, select the :guilabel:`Google Calendar API` and :guilabel:`User Data` options. Then, click :guilabel:`Next`. -.. image:: google_calendar_credentials/credential-type.png +.. image:: google/credential-type.png :align: center :alt: Select Google Calendar API and User Data for the Credential Type. @@ -76,7 +76,7 @@ four steps to create your API credentials. your company's Odoo URL address followed by */google_account/authentication*. Finally, click :guilabel:`Create` and :guilabel:`Done`. -.. image:: google_calendar_credentials/uri.png +.. image:: google/uri.png :align: center :alt: Add the authorized JavaScript origins and the authorized redirect URIs. @@ -94,7 +94,7 @@ Next, locate the credentials you just created for the Google Calendar API. Then, :guilabel:`Edit OAuth Client` (the pencil icon). The page will redirect to the edit page, where you can view the Client ID and the Client Secret. -.. image:: google_calendar_credentials/edit-oauth-2.png +.. image:: google/edit-oauth-2.png :align: center :alt: Click Edit OAuth Client to view the credential details. @@ -105,7 +105,7 @@ Once the Client ID and the Client Secret are located, open the Odoo database and :menuselection:`Settings --> General Settings --> Integrations --> Google Calendar`. Check the box next to :guilabel:`Google Calendar`. -.. image:: google_calendar_credentials/settings-google-cal.png +.. image:: google/settings-google-cal.png :align: center :alt: The Google Calendar checkbox in General Settings. @@ -116,7 +116,7 @@ page into their respective fields below the :guilabel:`Google Calendar` checkbox Finally, open the Calendar module in Odoo and click on the :guilabel:`Google` sync button to sync Google Calendar with Odoo. -.. image:: google_calendar_credentials/sync-google.png +.. image:: google/sync-google.png :align: center :alt: Click the Google sync button in Odoo Calendar to sync Google Calendar with Odoo. @@ -124,12 +124,12 @@ Google Calendar with Odoo. The first time you sync your Google Calendar with Odoo, the page will redirect to your Google Account. Click :guilabel:`OK` and :guilabel:`Allow` to authorize Odoo to access Google Calendar. -.. image:: google_calendar_credentials/trust-odoo.png +.. image:: google/trust-odoo.png :align: center :alt: Give Odoo permission to access Google Calendar. Now, Odoo Calendar is successfully synced with Google Calendar! -.. image:: google_calendar_credentials/successful-sync.png +.. image:: google/successful-sync.png :align: center :alt: Successfully sync between Odoo and Google Calendar. diff --git a/content/applications/general/calendars/google/google_calendar_credentials/credential-type.png b/content/applications/productivity/calendar/google/credential-type.png similarity index 100% rename from content/applications/general/calendars/google/google_calendar_credentials/credential-type.png rename to content/applications/productivity/calendar/google/credential-type.png diff --git a/content/applications/general/calendars/google/google_calendar_credentials/edit-oauth-2.png b/content/applications/productivity/calendar/google/edit-oauth-2.png similarity index 100% rename from content/applications/general/calendars/google/google_calendar_credentials/edit-oauth-2.png rename to content/applications/productivity/calendar/google/edit-oauth-2.png diff --git a/content/applications/general/calendars/google/google_calendar_credentials/enable-apis-services.png b/content/applications/productivity/calendar/google/enable-apis-services.png similarity index 100% rename from content/applications/general/calendars/google/google_calendar_credentials/enable-apis-services.png rename to content/applications/productivity/calendar/google/enable-apis-services.png diff --git a/content/applications/general/calendars/google/google_calendar_credentials/enable-google-cal-api.png b/content/applications/productivity/calendar/google/enable-google-cal-api.png similarity index 100% rename from content/applications/general/calendars/google/google_calendar_credentials/enable-google-cal-api.png rename to content/applications/productivity/calendar/google/enable-google-cal-api.png diff --git a/content/applications/general/calendars/google/google_calendar_credentials/new-api-project.png b/content/applications/productivity/calendar/google/new-api-project.png similarity index 100% rename from content/applications/general/calendars/google/google_calendar_credentials/new-api-project.png rename to content/applications/productivity/calendar/google/new-api-project.png diff --git a/content/applications/general/calendars/google/google_calendar_credentials/settings-google-cal.png b/content/applications/productivity/calendar/google/settings-google-cal.png similarity index 100% rename from content/applications/general/calendars/google/google_calendar_credentials/settings-google-cal.png rename to content/applications/productivity/calendar/google/settings-google-cal.png diff --git a/content/applications/general/calendars/google/google_calendar_credentials/successful-sync.png b/content/applications/productivity/calendar/google/successful-sync.png similarity index 100% rename from content/applications/general/calendars/google/google_calendar_credentials/successful-sync.png rename to content/applications/productivity/calendar/google/successful-sync.png diff --git a/content/applications/general/calendars/google/google_calendar_credentials/sync-google.png b/content/applications/productivity/calendar/google/sync-google.png similarity index 100% rename from content/applications/general/calendars/google/google_calendar_credentials/sync-google.png rename to content/applications/productivity/calendar/google/sync-google.png diff --git a/content/applications/general/calendars/google/google_calendar_credentials/trust-odoo.png b/content/applications/productivity/calendar/google/trust-odoo.png similarity index 100% rename from content/applications/general/calendars/google/google_calendar_credentials/trust-odoo.png rename to content/applications/productivity/calendar/google/trust-odoo.png diff --git a/content/applications/general/calendars/google/google_calendar_credentials/uri.png b/content/applications/productivity/calendar/google/uri.png similarity index 100% rename from content/applications/general/calendars/google/google_calendar_credentials/uri.png rename to content/applications/productivity/calendar/google/uri.png diff --git a/content/applications/general/calendars/outlook/outlook_calendar.rst b/content/applications/productivity/calendar/outlook.rst similarity index 91% rename from content/applications/general/calendars/outlook/outlook_calendar.rst rename to content/applications/productivity/calendar/outlook.rst index d5ce06e83..bc9227cb5 100644 --- a/content/applications/general/calendars/outlook/outlook_calendar.rst +++ b/content/applications/productivity/calendar/outlook.rst @@ -1,6 +1,6 @@ -====================================== -Synchronize Outlook Calendar with Odoo -====================================== +================================ +Outlook Calendar synchronization +================================ Synchronizing a user's Outlook Calendar with Odoo is useful for keeping track of their tasks and appointments across all related applications. @@ -33,7 +33,7 @@ URI (URL) followed by `/microsoft_account/authentication`. Enter `https://www.companyname.odoo.com/microsoft_account/authentication` for the :guilabel:`Redirect URI`. -.. image:: outlook_calendar/azure-register-application.png +.. image:: outlook/azure-register-application.png :align: center :alt: The "Supported account type" and "Redirect URI" settings in the Microsoft Azure AD portal. @@ -58,27 +58,27 @@ Configuration in Odoo In the Odoo database, go to :menuselection:`Settings --> General Settings --> Integrations` and activate the :guilabel:`Outlook Calendar` setting. -.. image:: outlook_calendar/outlook-calendar-setting.png +.. image:: outlook/outlook-calendar-setting.png :align: center :alt: The "Outlook Calendar" setting activated in Odoo. From the Microsoft Azure portal, under the :guilabel:`Overview` section of the application, copy the :guilabel:`Application (Client) ID`, and paste it into the :guilabel:`Client ID` field in Odoo. -.. image:: outlook_calendar/client-id.png +.. image:: outlook/client-id.png :align: center :alt: The "Client ID" in the Microsoft Azure portal. In the Microsoft Azure portal, under the :guilabel:`Certificates & secrets` section, copy the :guilabel:`Client Secret Value` and paste it into the :guilabel:`Client Secret` field in Odoo. -.. image:: outlook_calendar/client-secret-value.png +.. image:: outlook/client-secret-value.png :align: center :alt: The "Client Secret" token to be copied from Microsoft to Odoo. Finally, on the Odoo :menuselection:`Settings --> General Settings` page, click :guilabel:`Save`. -.. _outlook_calendar/sync_with_outlook: +.. _outlook/sync: Sync with Outlook ================= @@ -125,7 +125,7 @@ In the Odoo database, go to the :guilabel:`Calendar` module and click the :guila button. The page will redirect to a Microsoft login page, and the user is asked to log in to their account, if they are not already, and grant the required permissions. -.. image:: outlook_calendar/outlook-sync-button.png +.. image:: outlook/outlook-sync-button.png :align: center :alt: The "Outlook" sync button in Odoo Calendar. @@ -134,11 +134,11 @@ The synchronization is a two-way process, meaning that events are reconciled in .. note:: All users that want to use the synchronization simply need to :ref:`sync their calendar with - Outlook `. The configuration of Microsoft's Azure account + Outlook `. The configuration of Microsoft's Azure account is only done once, as Azure AD tenants' Client IDs and Client Secrets are unique, and represent an organization that helps the user to manage a specific instance of Microsoft cloud services for their internal and external users. .. seealso:: - - :doc:`../../../productivity/mail_plugins/outlook` - - :doc:`../google/google_calendar_credentials` + - :doc:`../mail_plugins/outlook` + - :doc:`google` diff --git a/content/applications/general/calendars/outlook/outlook_calendar/azure-register-application.png b/content/applications/productivity/calendar/outlook/azure-register-application.png similarity index 100% rename from content/applications/general/calendars/outlook/outlook_calendar/azure-register-application.png rename to content/applications/productivity/calendar/outlook/azure-register-application.png diff --git a/content/applications/general/calendars/outlook/outlook_calendar/client-id.png b/content/applications/productivity/calendar/outlook/client-id.png similarity index 100% rename from content/applications/general/calendars/outlook/outlook_calendar/client-id.png rename to content/applications/productivity/calendar/outlook/client-id.png diff --git a/content/applications/general/calendars/outlook/outlook_calendar/client-secret-value.png b/content/applications/productivity/calendar/outlook/client-secret-value.png similarity index 100% rename from content/applications/general/calendars/outlook/outlook_calendar/client-secret-value.png rename to content/applications/productivity/calendar/outlook/client-secret-value.png diff --git a/content/applications/general/calendars/outlook/outlook_calendar/outlook-calendar-setting.png b/content/applications/productivity/calendar/outlook/outlook-calendar-setting.png similarity index 100% rename from content/applications/general/calendars/outlook/outlook_calendar/outlook-calendar-setting.png rename to content/applications/productivity/calendar/outlook/outlook-calendar-setting.png diff --git a/content/applications/general/calendars/outlook/outlook_calendar/outlook-sync-button.png b/content/applications/productivity/calendar/outlook/outlook-sync-button.png similarity index 100% rename from content/applications/general/calendars/outlook/outlook_calendar/outlook-sync-button.png rename to content/applications/productivity/calendar/outlook/outlook-sync-button.png diff --git a/content/applications/general/calendars/outlook/outlook_calendar/redirect-uri.png b/content/applications/productivity/calendar/outlook/redirect-uri.png similarity index 100% rename from content/applications/general/calendars/outlook/outlook_calendar/redirect-uri.png rename to content/applications/productivity/calendar/outlook/redirect-uri.png diff --git a/redirects/14.0.txt b/redirects/14.0.txt index 7f3743bd1..695296d06 100644 --- a/redirects/14.0.txt +++ b/redirects/14.0.txt @@ -35,6 +35,11 @@ applications/finance/accounting/fiscal_localizations/overview/localizations_list applications/finance/accounting/getting_started/memento.rst applications/finance/accounting/getting_started/cheat_sheet.rst # memento -> cheat_sheet applications/finance/accounting/payables/supplier_bills/manage.rst applications/inventory_and_mrp/purchase/manage_deals/manage.rst # (#3302) +# applications/general + +applications/general/calendars/outlook/outlook_calendar.rst applications/productivity/calendar/outlook.rst # general/calendars/outlook/outlook_calendar -> productivity/calendar/outlook +applications/general/calendars/google/google_calendar_credentials.rst applications/productivity/calendar/google.rst # general/calendars/google/google_calendar_credentials -> productivity/calendar/google + # applications/inventory applications/inventory_and_mrp/inventory/routes/concepts/inter_warehouse.rst applications/inventory_and_mrp/inventory/management/warehouses/warehouse_replenishment_transfer.rst