Skip to content

Conversation

@lse-odoo
Copy link
Contributor

@lse-odoo lse-odoo commented Mar 1, 2022

No description provided.

@robodoo
Copy link
Collaborator

robodoo commented Mar 1, 2022

@lse-odoo
Copy link
Contributor Author

lse-odoo commented Mar 1, 2022

@Feyensv could you review it please ? :) It's been a loooong while that I didn't made a PR for the documentation, let me know if I need to ping someone in particular for that

@lse-odoo lse-odoo requested a review from AntoineVDV March 1, 2022 16:04
@Feyensv
Copy link
Collaborator

Feyensv commented Mar 1, 2022

There are codeowners for the doc as well now, so C3POdoo should assign them automatically, and after the codeowners have reviewed the PR, they ping us (doc-review team, ANV & I) for the tech review & r+.

@C3POdoo C3POdoo requested a review from a team March 1, 2022 16:29
@AntoineVDV
Copy link
Collaborator

AntoineVDV commented Mar 1, 2022

There was an issue with the code owners mapping. It's now fixed 🚀

@AntoineVDV AntoineVDV removed their request for review March 1, 2022 16:38
Copy link
Contributor

@meng-odoo meng-odoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lse-odoo Hello! Thanks for your contribution here. I'm requesting some small changes, mostly to improve wording and sentence flow, before we approve. Please let me know if you have any questions :)

trial. This feature requires :ref:`prepaid credits <mail_plugins/pricing>`.

.. warning::
If, after a short while, the panel is still empty. It is possible that your browser cookies
Copy link
Contributor

@meng-odoo meng-odoo Apr 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made small changes to this sentence to fix a sentence fragment and improve flow.

If, after a short while, the panel is still empty, it is possible that your browser cookie


.. warning::
If, after a short while, the panel is still empty. It is possible that your browser cookies
settings policy did prevent it to load.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small changes to improve sentence flow.

settings prevented it from loading.

.. warning::
If, after a short while, the panel is still empty. It is possible that your browser cookies
settings policy did prevent it to load.
Note that this policy does also change if you are connected in "Incognito" mode on your
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small changes to improve sentence flow.

Note that these settings also change if you are in "Incognito" mode on your


To fix this issue, you can configure your browser to always allow cookies on Odoo's plugin page.

For Chrome in particular you can do so by following the guide at:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small changes to improve wording and punctuation.

For Google Chrome, you can do so by following the guide at

Note that this policy does also change if you are connected in "Incognito" mode on your
browser.

To fix this issue, you can configure your browser to always allow cookies on Odoo's plugin page.
Copy link
Contributor

@meng-odoo meng-odoo Apr 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deleted "you can" so that it reads more like instructions, rather than just an option.

To fix this issue, configure your browser to always allow cookies on Odoo's plugin page.


For Chrome in particular you can do so by following the guide at:
`https://support.google.com/chrome/answer/95647 <https://support.google.com/chrome/answer/95647#:~:text=Allow%20or%20block%20cookies%20for%20a%20specific%20site>`_
then add `download.odoo.com` in the list of `Sites that can always use cookies`.
Copy link
Contributor

@meng-odoo meng-odoo Apr 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small changes to keep the grammar consistent throughout the sentence.

and adding download.odoo.com to the list of Sites that can always use cookies.

Please note that I removed the backtick punctuation around "download.odoo.com" and "Sites that can always use cookies" in my corrected quote above, because Github reads it as formatting. You'll want to keep those backticks in the actual version.

:align: center
:alt: Chrome cookie configuration to fix the empty panel issue

Once done, the panel needs to be open again.
Copy link
Contributor

@meng-odoo meng-odoo Apr 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed a small grammar mistake.

Once done, the panel needs to be opened again.

Also, which panel are you referring to here? It might be good to specify.

@lse-odoo lse-odoo force-pushed the 15.0-microsoft_calendar_plugin_cookie_fix-lse branch from 41be2df to 7da13e7 Compare April 26, 2022 11:21
@robodoo
Copy link
Collaborator

robodoo commented Apr 26, 2022

Sorry, I didn't know about this PR and had to retrieve its information, you may have to re-approve it.

@robodoo
Copy link
Collaborator

robodoo commented Apr 26, 2022

@lse-odoo lse-odoo requested a review from meng-odoo April 26, 2022 11:23
@lse-odoo
Copy link
Contributor Author

@meng-odoo thank you for your review. I did update the text accordingly (in theory). Let me know your thoughts on the matter

Copy link
Contributor

@meng-odoo meng-odoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lse-odoo Hi! Thank you very much for making the suggested changes. All of the changes look good.

Upon a second review, I believe we should change a couple more key things before approving: making it a Tip instead of a Warning, and removing the image. Please see my comments below and let me know if you have any questions :)

Only a limited amount of *Company Insights* (*Lead Enrichment*) requests are available as a
trial. This feature requires :ref:`prepaid credits <mail_plugins/pricing>`.

.. warning::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's change this to a Tip instead of a Warning, because it informs readers about a useful trick, rather than warning them to proceed with caution.

.. tip::

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@meng-odoo Speaking about tips, you can click on the "Add a suggestion button" or use ctrl-g to easily make suggestions.

For example:

Suggested change
.. warning::
.. tip::

cc @StraubCreative


.. image:: outlook/cookie-fix.png
:align: center
:alt: Chrome cookie configuration to fix the empty panel issue
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's delete this image. For platforms outside of Odoo, we want to link to guides from those platforms, rather than walking through the instructions on Odoo's documentation. So what you did here by linking to Google's support page is perfect, and we don't need to include more Google Chrome content in addition to that.

Also, we try not to use too many images. Although your image is helpful, it is not completely necessary for the reader to understand the instructions.

@lse-odoo lse-odoo force-pushed the 15.0-microsoft_calendar_plugin_cookie_fix-lse branch from 7da13e7 to 3fa47eb Compare April 27, 2022 14:45
@lse-odoo
Copy link
Contributor Author

@meng-odoo I do think that adding pictures can help customers visualise what to do and if the settings did change with time. But I do understand that it can indeed be confusing for some. I did remove it as you asked (and changed to a tip).
Let me know if you notice something else :)

Copy link
Contributor

@meng-odoo meng-odoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lse-odoo Hi, thanks again for making the suggested changes! Everything looks great. I'll go ahead and move this to the next stage in the review process.

@meng-odoo meng-odoo requested a review from a team April 27, 2022 17:39
Copy link
Collaborator

@AntoineVDV AntoineVDV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment on lines +79 to +82
If, after a short while, the panel is still empty, it is possible that your browser cookie
settings prevented it from loading.
Note that these settings also change if you are in "Incognito" mode on your
browser.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpicking for your future PRs: It's better not to return to a new line if you don't intend to start a new paragraph. Indeed, single line breaks have no effect on the rendered HTML so it can be confusing for the technical reader to see useless line breaks.

To fix this issue, configure your browser to always allow cookies on Odoo's plugin page.

For Google Chrome, you can do so by following the guide at:
`https://support.google.com/chrome/answer/95647 <https://support.google.com/chrome/answer/95647#:~:text=Allow%20or%20block%20cookies%20for%20a%20specific%20site>`_
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpicking for your future PRs: you can break the line anywhere inside a link label.

Suggested change
`https://support.google.com/chrome/answer/95647 <https://support.google.com/chrome/answer/95647#:~:text=Allow%20or%20block%20cookies%20for%20a%20specific%20site>`_
`https://support.google.com/chrome/answer/95647
<https://support.google.com/chrome/answer/95647#:~:text=Allow%20or%20block%20cookies%20for%20a%20specific%20site>`_

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants