[IMP] General: Google Oauth Docs edit #3965

tiku-odoo · 2023-03-29T19:22:04Z

Targets 14.0 onward.

Google Oauth Changes to Sign-On, Calendar, Gmail
Changes: update to match new interface and remove second person, add details on Internal and External User Types.

Google Calendar Sync doc
https://www.odoo.com/web#id=3246409&cids=3&menu_id=4720&action=333&active_id=3835&model=project.task&view_type=form

[Calendar] Google Sync warning
https://www.odoo.com/web#id=3000531&cids=3&menu_id=4720&action=333&active_id=3835&model=project.task&view_type=form

Google Calendar Sync Videos
https://www.odoo.com/web#id=2859258&cids=3&menu_id=4720&action=333&active_id=3835&model=project.task&view_type=form

Google Sign-In Authentication User Type
https://www.odoo.com/web#id=3247706&cids=3&menu_id=4720&action=333&active_id=3835&model=project.task&view_type=form

[auth] rewrite google.rst
https://www.odoo.com/web#id=3252200&cids=3&model=project.task&view_type=form

robodoo · 2023-03-29T19:22:22Z

Pull request status dashboard.

tiku-odoo · 2023-03-29T19:57:16Z

@bouvyd When you have a moment, can you review this PR's changes for accuracy? I updated the 3 Google Oauth docs for UI accuracy and clarified the User Type (Internal Vs. External).

Thanks in advance for your review 👍

tiku-odoo · 2023-03-30T16:10:33Z

@odoo/us-doc-review This set of docs is ready for your review when you have some time. Thanks in advance for your time on these 👍

ksc-odoo

Hey @tiku-odoo Just finished a peer review on this one - Great work! Let me know if you have any questions or need clarification on anything.

content/administration/maintain/google_oauth.rst

content/applications/general/calendars/google/google_calendar_credentials.rst

tiku-odoo · 2023-04-06T15:27:59Z

@samueljlieber These docs are ready for your technical review.

Thanks in advanced for your help on these.

samueljlieber · 2023-04-17T14:24:03Z

Fixed merge conflict in f9a7849.

jcs-odoo · 2023-04-17T14:49:58Z

Hi @samueljlieber

I think your last force-push is incorrect as it moves the calendar docs back to general/calendars. The docs were moved to productivity/calendar, as introduced in #4032

jcs-odoo

This pr currently reverts the structure change made in #4032 . Is this unintentional? The conflict during rebase should be handled the other way around (the pr adapts to the current structure of the doc)

samueljlieber · 2023-04-17T15:58:57Z

Hi @samueljlieber

I think your last force-push is incorrect as it moves the calendar docs back to general/calendars. The docs were moved to productivity/calendar, as introduced in #4032

This pr currently reverts the structure change made in #4032 . Is this unintentional? The conflict during rebase should be handled the other way around (the pr adapts to the current structure of the doc)

Hi @jcs-odoo Ah - I see I may have misunderstood the changes in this PR when correcting the merge conflict. Let me review with @tiku-odoo and @StraubCreative and I will correct this.

jcs-odoo · 2023-04-17T16:35:21Z

Hi @samueljlieber
I think your last force-push is incorrect as it moves the calendar docs back to general/calendars. The docs were moved to productivity/calendar, as introduced in #4032

This pr currently reverts the structure change made in #4032 . Is this unintentional? The conflict during rebase should be handled the other way around (the pr adapts to the current structure of the doc)

Hi @jcs-odoo Ah - I see I may have misunderstood the changes in this PR when correcting the merge conflict. Let me review with @tiku-odoo and @StraubCreative and I will correct this.

Thanks 😊

samueljlieber · 2023-04-17T18:19:27Z

Hi @tiku-odoo & @jcs-odoo 👋

I reverted the changes I made in my merge conflict commit (f9a7849) and applied my technical changes on the correct structure, my apologies for the mix-up!

I received approval of the technical changes from @tiku-odoo externally, so I'm ready to hand this off to @StraubCreative for a final review.

Thank you 🙂

StraubCreative

Hi @tiku-odoo

Pausing here. Seeing a bunch of RST tag use and capitalization issues here.

There are spots where passive language is hurting your ability to communicate clearly and also justify the use of specific RST tags. As a result there's lots of gray area for how to format things...

Ideally, there's no question around formatting if the language is clear/assertive and we don't unnecessarily refer to UI elements unless using active instruction. For example, why are we talking about field names/values if we're not even on the screen yet (e.g. Client ID/Keys)?

Can you take another look please?

Thanks!

StraubCreative · 2023-04-19T00:36:15Z

content/administration/maintain/google_oauth.rst

+Click on :guilabel:`OAuth consent screen` in the left menu, under :guilabel:`User Type` options,
+select the appropriate :guilabel:`User Type`, and then click on :guilabel:`Create` again, which will
 finally navigate to the :guilabel:`Edit app registration` page.

+.. warning::
+   Personal Gmail accounts are only allowed to be :guilabel:`External` User Type, which means Google
+   may require an approval, or for :guilabel:`Scopes` to be added on. Using a Google WorkSpace
+   account allows for :guilabel:`Internal` User Type. It should also be noted, that while the API
+   connection is in the :guilabel:`External` :guilabel:`Testing` mode, then no approval is necessary
+   from Google. User limits in this *testing* mode is set to 100 users.


@tiku-odoo can you take another look here around guilabel usage?

It seems that some of these should be in bold or italics since they appear to:

be referred to theoretically, and not through active UI instruction

not be the actual names of headings, buttons, fields, values, etc. on the UI

Also consider not mentioning field names, headings, etc. at all unless active UI instruction is given.

As well, check capitalization since none of these appear to be proper nouns or product names, i.e. is External User Type supposed to be capitalized? Is this unique to Google?

I'm not saying there's a clear right answer for every case, however with the way this is written it's difficult to decipher. You might benefit from changing the language around slightly to force specific RST use more clearly, or again, omit UI elements entirely from the copy leading up to active instruction.

content/administration/maintain/google_oauth.rst

samueljlieber · 2023-04-25T13:53:40Z

Hi @tiku-odoo, I pushed your changes to the docs in ad7795f. Please review and tag ZST when you are ready 🙂

To pull down these changes, please use git pull --rebase - let me know if you have any issues doing so!

tiku-odoo · 2023-04-25T14:04:36Z

@StraubCreative This doc is ready for another look by you. I made changes to the GUI Labels. They do appear capitalized in the UI. I've used italics in many of the cases. Thanks for your suggestions.

StraubCreative

Hi @tiku-odoo

Nice cleanup here.
I have change requests below which I'll be pushing up momentarily for merge.

There are a few questions in my review which we might want to consider for different versions of these docs. As well, I'm not convinced the "bullet-list style" works (vs. a narrative guide) so wherever that's the dominant style on a doc, a rewrite might be warranted there.

StraubCreative · 2023-04-28T19:18:15Z

content/administration/maintain/google_oauth.rst

Formatting suggestion to help emphasize terms vs. differences in account types.

Suggested change

Personal Gmail Accounts are only allowed to be *External* User Type, which means Google may

require an approval, or for *Scopes* to be added on. Using a Google WorkSpace account allows for

*Internal* User Type. It should also be noted, that while the API connection is in the *External*

testing mode, then no approval is necessary from Google. User limits in this testing mode is set

to 100 users.

*Personal* Gmail Accounts are only allowed to be **External** User Type, which means Google may

require an approval, or for *Scopes* to be added on. However, using a *Google WorkSpace* account

allows for **Internal** User Type to be used.

Note, as well, that while the API connection is in the *External* testing mode, then no approval is

necessary from Google. User limits in this testing mode is set to 100 users.

StraubCreative · 2023-04-28T19:27:41Z

content/administration/maintain/google_oauth.rst

Reverting this section to paragraph form and adding an intro sentence + conclusion.

Suggested change

- Finally, scroll to the bottom and click on :guilabel:`Back to Dashboard`.

Next we will configure the app registration of the project.

On the :guilabel:`OAuth consent screen` step, under the :guilabel:`App information` section, enter

`Odoo` in the :guilabel:`App name` field. Select the organization's email address under the

:guilabel:`User support` email field.

Next, under :menuselection:`App Domain --> Authorized domains`, click on :guilabel:`Add Domain` and

enter `odoo.com`.

After that, under the :guilabel:`Developer contact information` section, enter the organization's

email address. Google uses this email address to notify the organization about any changes to your

project.

Next, click on the :guilabel:`Save and Continue` button. Then, skip the :menuselection:`Scopes` page

by scrolling to the bottom and clicking on :guilabel:`Save and Continue`.

If continuing in testing mode (External), add the email addresses being configured under the

:guilabel:`Test users` step, by clicking on :guilabel:`Add Users`, and then the :guilabel:`Save and

Continue` button. A summary of the app registration appears.

Finally, scroll to the bottom and click on :guilabel:`Back to Dashboard` to finish setting up the

project.

StraubCreative · 2023-04-28T19:30:11Z

content/administration/maintain/google_oauth.rst

Reverting to single backticks for standard/consistency.

Suggested change

- In the :guilabel:`Name` field, enter ``Odoo``.

- In the :guilabel:`Name` field, enter `Odoo`.

StraubCreative · 2023-04-28T19:39:52Z

content/administration/maintain/google_oauth.rst

100th char

Suggested change

- Next, click on :guilabel:`Create` to generate an OAuth :guilabel:`Client ID` and

:guilabel:`Client Secret`. Finally, copy each generated value for later use when configuring in

Odoo, and then navigate to the Odoo database.

- Next, click on :guilabel:`Create` to generate an OAuth :guilabel:`Client ID` and :guilabel:`Client

Secret`. Finally, copy each generated value for later use when configuring in Odoo, and then

navigate to the Odoo database.

StraubCreative · 2023-04-28T19:41:38Z

content/administration/maintain/google_oauth.rst

Justifying the guilabels

Suggested change

a Gmail Sever`. Then, copy and paste the :guilabel:`Client ID` and :guilabel:`Client Secret` into

the respective fields and :guilabel:`Save` the settings.

a Gmail Sever`. Then, copy and paste the respective values into the :guilabel:`Client ID` and

:guilabel:`Client Secret` fields and :guilabel:`Save` the settings.

StraubCreative · 2023-04-28T20:39:55Z

content/applications/productivity/calendar/google.rst

Suggested change

.. warning::

Personal Gmail Accounts are only allowed to be *External* User Type, which means Google may

require an approval, or for *Scopes* to be added on. Using a Google WorkSpace account allows for

*Internal* User Type. It should also be noted, that while the API connection is in the *External*

testing mode, then no approval is necessary from Google. User limits in this testing mode is set

to 100 users.

.. warning::

*Personal* Gmail Accounts are only allowed to be **External** User Type, which means Google may

require an approval, or for *Scopes* to be added on. However, using a *Google WorkSpace* account

allows for **Internal** User Type to be used.

Note, as well, that while the API connection is in the *External* testing mode, then no approval is

necessary from Google. User limits in this testing mode is set to 100 users.

StraubCreative · 2023-04-28T20:40:47Z

content/applications/productivity/calendar/google.rst

this is string input so gets pre formatting
also, 100th char line breaks

Suggested change

In the second step, :guilabel:`OAuth Consent Screen`, type *Odoo* in the :guilabel:`App name`

field, select the email address for the :guilabel:`User support email` field, and type the email

address for the :guilabel:`Developer contact information` section. Then, click :guilabel:`Save

and Continue`.

In the second step, :guilabel:`OAuth Consent Screen`, type `Odoo` in the :guilabel:`App name` field,

select the email address for the :guilabel:`User support email` field, and type the email address

for the :guilabel:`Developer contact information` section. Then, click :guilabel:`Save and

Continue`.

StraubCreative · 2023-04-28T20:41:34Z

content/applications/productivity/calendar/google.rst

Suggested change

The *Client ID* and the *Client Secret* are both needed to connect Google Calendar to Odoo. This

is the last step in the Google console. Begin by clicking :guilabel:`Credentials` in the left menu.

The *Client ID* and the *Client Secret* are both needed to connect Google Calendar to Odoo. This is

the last step in the Google console. Begin by clicking :guilabel:`Credentials` in the left menu.

StraubCreative · 2023-04-28T20:43:37Z

content/applications/productivity/calendar/google.rst

menuselection has too many colons (::)
these are guilabels anyway.

Suggested change

- Under the ::menuselection:`Authorized JavaScript Origins` section, click :guilabel:`+ Add URI` and

type the company's Odoo full :abbr:`URL (Uniform Resource Locator)` address.

- Under the ::menuselection:`Authorized redirect URIs` section, click :guilabel:`+ Add URI` and type

- Under the :guilabel:`Authorized JavaScript Origins` section, click :guilabel:`+ Add URI` and

type the company's Odoo full :abbr:`URL (Uniform Resource Locator)` address.

- Under the :guilabel:`Authorized redirect URIs` section, click :guilabel:`+ Add URI` and type

StraubCreative · 2023-04-28T20:46:11Z

content/applications/productivity/calendar/google.rst

Is this screenshot only for 16? @tiku-odoo

This should be relevant for all versions @StraubCreative

StraubCreative

@robodoo r+

closes #3965 Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

C3POdoo requested review from a team March 29, 2023 19:23

tiku-odoo force-pushed the 14.0-Misc-Oauth-Update-All-Oauth-Pages branch from 7c648ee to 7f4370b Compare March 29, 2023 19:29

tiku-odoo requested a review from bouvyd March 29, 2023 19:31

tiku-odoo force-pushed the 14.0-Misc-Oauth-Update-All-Oauth-Pages branch from 7f4370b to bf9ceae Compare March 29, 2023 19:56

tiku-odoo requested a review from a team March 30, 2023 16:02

tiku-odoo force-pushed the 14.0-Misc-Oauth-Update-All-Oauth-Pages branch from bf9ceae to 6ffbc30 Compare March 30, 2023 16:10

ksc-odoo reviewed Apr 1, 2023

View reviewed changes

bouvyd approved these changes Apr 3, 2023

View reviewed changes

tiku-odoo force-pushed the 14.0-Misc-Oauth-Update-All-Oauth-Pages branch 2 times, most recently from 1018e30 to 1be920c Compare April 6, 2023 15:23

tiku-odoo requested review from StraubCreative and samueljlieber and removed request for StraubCreative April 6, 2023 15:26

samueljlieber force-pushed the 14.0-Misc-Oauth-Update-All-Oauth-Pages branch from 1be920c to f9a7849 Compare April 17, 2023 14:23

C3POdoo requested a review from a team April 17, 2023 14:25

jcs-odoo requested changes Apr 17, 2023

View reviewed changes

This comment was marked as outdated.

Sign in to view

samueljlieber force-pushed the 14.0-Misc-Oauth-Update-All-Oauth-Pages branch from f9a7849 to c559778 Compare April 17, 2023 18:12

samueljlieber approved these changes Apr 17, 2023

View reviewed changes

samueljlieber requested a review from StraubCreative April 17, 2023 18:20

StraubCreative requested changes Apr 19, 2023

View reviewed changes

samueljlieber force-pushed the 14.0-Misc-Oauth-Update-All-Oauth-Pages branch from c559778 to ad7795f Compare April 25, 2023 13:45

tiku-odoo requested a review from StraubCreative April 25, 2023 14:02

tiku-odoo self-assigned this Apr 25, 2023

tiku-odoo force-pushed the 14.0-Misc-Oauth-Update-All-Oauth-Pages branch 2 times, most recently from 7ca40fb to 2d2c835 Compare April 28, 2023 19:11

StraubCreative requested changes Apr 28, 2023

View reviewed changes

[IMP] Google Oauth Docs edits final review

143812c

StraubCreative force-pushed the 14.0-Misc-Oauth-Update-All-Oauth-Pages branch from 2d2c835 to 143812c Compare April 28, 2023 20:50

StraubCreative approved these changes Apr 28, 2023

View reviewed changes

robodoo pushed a commit that referenced this pull request Apr 28, 2023

[IMP] Google Oauth Docs edits final review

5b63bfc

closes #3965 Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

robodoo temporarily deployed to merge April 28, 2023 21:42 Inactive

robodoo closed this Apr 28, 2023

tiku-odoo mentioned this pull request May 17, 2023

[ADD] Productivity: IoT - Windows IoT doc #4025

Closed

-   Personal Gmail Accounts are only allowed to be *External* User Type, which means Google may
-   require an approval, or for *Scopes* to be added on. Using a Google WorkSpace account allows for
-   *Internal* User Type. It should also be noted, that while the API connection is in the *External*
-   testing mode, then no approval is necessary from Google. User limits in this testing mode is set
-   to 100 users.
+   *Personal* Gmail Accounts are only allowed to be **External** User Type, which means Google may
+   require an approval, or for *Scopes* to be added on. However, using a *Google WorkSpace* account
+   allows for **Internal** User Type to be used.
+   Note, as well, that while the API connection is in the *External* testing mode, then no approval is
+   necessary from Google. User limits in this testing mode is set to 100 users.

-- Finally, scroll to the bottom and click on :guilabel:`Back to Dashboard`.
+Next we will configure the app registration of the project.
+On the :guilabel:`OAuth consent screen` step, under the :guilabel:`App information` section, enter
+`Odoo` in the :guilabel:`App name` field. Select the organization's email address under the
+:guilabel:`User support` email field.
+Next, under :menuselection:`App Domain --> Authorized domains`, click on :guilabel:`Add Domain` and
+enter `odoo.com`.
+After that, under the :guilabel:`Developer contact information` section, enter the organization's
+email address. Google uses this email address to notify the organization about any changes to your
+project.
+Next, click on the :guilabel:`Save and Continue` button. Then, skip the :menuselection:`Scopes` page
+by scrolling to the bottom and clicking on :guilabel:`Save and Continue`.
+If continuing in testing mode (External), add the email addresses being configured under the
+:guilabel:`Test users` step, by clicking on :guilabel:`Add Users`, and then the :guilabel:`Save and
+Continue` button. A summary of the app registration appears.
+Finally, scroll to the bottom and click on :guilabel:`Back to Dashboard` to finish setting up the
+project.

	- In the :guilabel:`Name` field, enter ``Odoo``.
	- In the :guilabel:`Name` field, enter `Odoo`.

-- Next, click on :guilabel:`Create` to generate an OAuth :guilabel:`Client ID` and
-  :guilabel:`Client Secret`. Finally, copy each generated value for later use when configuring in
-  Odoo, and then navigate to the Odoo database.
+- Next, click on :guilabel:`Create` to generate an OAuth :guilabel:`Client ID` and :guilabel:`Client
+  Secret`. Finally, copy each generated value for later use when configuring in Odoo, and then
+  navigate to the Odoo database.

-a Gmail Sever`. Then, copy and paste the :guilabel:`Client ID` and :guilabel:`Client Secret` into
-the respective fields and :guilabel:`Save` the settings.
+a Gmail Sever`. Then, copy and paste the respective values into the :guilabel:`Client ID` and
+:guilabel:`Client Secret` fields and :guilabel:`Save` the settings.

-In the second step, :guilabel:`OAuth Consent Screen`, type *Odoo* in the :guilabel:`App name`
-field, select the email address for the :guilabel:`User support email` field, and type the email
-address for the :guilabel:`Developer contact information` section. Then, click :guilabel:`Save
-and Continue`.
+In the second step, :guilabel:`OAuth Consent Screen`, type `Odoo` in the :guilabel:`App name` field,
+select the email address for the :guilabel:`User support email` field, and type the email address
+for the :guilabel:`Developer contact information` section. Then, click :guilabel:`Save and
+Continue`.

-The *Client ID* and the *Client Secret* are both needed to connect Google Calendar to Odoo. This
-is the last step in the Google console. Begin by clicking :guilabel:`Credentials` in the left menu.
+The *Client ID* and the *Client Secret* are both needed to connect Google Calendar to Odoo. This is
+the last step in the Google console. Begin by clicking :guilabel:`Credentials` in the left menu.

-- Under the ::menuselection:`Authorized JavaScript Origins` section, click :guilabel:`+ Add URI` and
-  type the company's Odoo full :abbr:`URL (Uniform Resource Locator)` address.
-- Under the ::menuselection:`Authorized redirect URIs` section, click :guilabel:`+ Add URI` and type
+- Under the :guilabel:`Authorized JavaScript Origins` section, click :guilabel:`+ Add URI` and
+  type the company's Odoo full :abbr:`URL (Uniform Resource Locator)` address.
+- Under the :guilabel:`Authorized redirect URIs` section, click :guilabel:`+ Add URI` and type

[IMP] General: Google Oauth Docs edit #3965

[IMP] General: Google Oauth Docs edit #3965

Uh oh!

Conversation

tiku-odoo commented Mar 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

robodoo commented Mar 29, 2023

Uh oh!

tiku-odoo commented Mar 29, 2023

Uh oh!

tiku-odoo commented Mar 30, 2023

Uh oh!

ksc-odoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tiku-odoo commented Apr 6, 2023

Uh oh!

samueljlieber commented Apr 17, 2023

Uh oh!

jcs-odoo commented Apr 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jcs-odoo left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

samueljlieber commented Apr 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jcs-odoo commented Apr 17, 2023

Uh oh!

samueljlieber commented Apr 17, 2023

Uh oh!

StraubCreative left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

StraubCreative Apr 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

samueljlieber commented Apr 25, 2023

Uh oh!

tiku-odoo commented Apr 25, 2023

Uh oh!

StraubCreative left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tiku-odoo commented Mar 29, 2023 •

edited

Loading

jcs-odoo commented Apr 17, 2023 •

edited

Loading

samueljlieber commented Apr 17, 2023 •

edited

Loading

StraubCreative left a comment •

edited

Loading

StraubCreative Apr 19, 2023 •

edited

Loading