-
Notifications
You must be signed in to change notification settings - Fork 10.5k
[IMP] misc: IAP grammar updates and new image #6778
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[IMP] misc: IAP grammar updates and new image #6778
Conversation
tiku-odoo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some edits for the IAP doc. Nice work. Let me know if you have any questions.
I will approve once you make the edits....
Tag: JERO or LARM next!
Thanks,
Tim
|
|
||
| .. image:: in_app_purchase/image4.png | ||
| :align: center | ||
| :alt: The Receive threshold warning box is checked and a Warning threshold is set. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
May want to add a section on manually editing the token in Odoo and where to edit (dev mode --> settings app--> technical menu-->
IAP-->
IAP Accounts
OR
IAP Partners
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agreed, added this to the IAP Accounts section
| To disable an IAP account, append `+disabled` to its token. To re-enable the account, remove | ||
| `+disabled` from the token. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
where? technical menu IAP-> IAP accounts (in dev mode)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Expanded this tip to be part of the overall IAP accounts section, added content for making changes and fuller steps for disabling an account. Also added a new image showing "+disabled" at the end of an account token.
d6265b1 to
9402328
Compare
tiku-odoo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You made some good edits, nice work..
Some additional comments. I would like to see you dive deeper into IAP and guide the user to things you find out. Doc could be fleshed out a bit more. Big thing is to access via the settings and be redirected with the logging to IAP.odoo.com.
Another thing to keep in mind is the 100-character limit. You're able to break up the labels on different lines. Let me know when you make some more changes and I'll take another look.
Thanks, Tim 👍
| In-App Purchases (IAP) gives access to additional services through Odoo. For instance, it allows you | ||
| to send SMS Text Messages or to send Invoices by post directly from your database. | ||
| In-App Purchases (IAP) grant access to additional services through Odoo. For instance, it allows the | ||
| sending of SMS text messages or invoices by post directly from a database. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What are all the IAP options?
iap.odoo.com
| Buying Credits | ||
| ============== | ||
| Credits for IAP services are stored on IAP accounts, which are specific to each service. By default, | ||
| IAP accounts are common to all companies, but can be restricted to specific ones. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How do you restrict them?
| Each IAP Service relies on prepaid credits to work and has its own pricing. To consult your current | ||
| balance or to recharge your account, go to :menuselection:`Settings --> Odoo IAP --> View my | ||
| Services`. | ||
| To make changes to IAP accounts, activate Odoo’s :ref:`developer mode <developer-mode>`. Return to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what kind of changes?
| the main apps page and type *IAP*. In the resulting drop-down menu select | ||
| :guilabel:`Settings / Technical / IAP / IAP Accounts`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| the main apps page and type *IAP*. In the resulting drop-down menu select | |
| :guilabel:`Settings / Technical / IAP / IAP Accounts`. | |
| the main apps page and type *IAP*. In the resulting drop-down menu select :guilabel:`Settings --> | |
| Technical --> IAP --> IAP Accounts`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We use arrows..... and you can break the GUI label so that it fills a line
| To disable an IAP account, click on the service and type `+disabled` at the end of the account token | ||
| . To re-enable the account, remove `+disabled` from the token. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| To disable an IAP account, click on the service and type `+disabled` at the end of the account token | |
| . To re-enable the account, remove `+disabled` from the token. | |
| To disable an IAP account, click on the service and type `+disabled` at the end of the account | |
| token. To re-enable the account, remove `+disabled` from the token. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can't break a period off a word
| balance, recharge your credits and set a reminder when your balance falls below a threshold. | ||
| The IAP portal is a platform for managing all IAP services. Actions that can be performed in the | ||
| portal include checking an account's balance, buying more credits (recharge), and setting reminders | ||
| to be automatically notified when an account’s balance falls below a specified threshold. To access, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| to be automatically notified when an account’s balance falls below a specified threshold. To access, | |
| to be automatically notified when an account's balance falls below a specified threshold. To access, |
All of the apostrophes need to be updated in this doc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How do I access manually?
| .. _Buy credits: | ||
|
|
||
| Buying credits | ||
| ============== |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
change this heading to be under the previous H2
| Each IAP service relies on prepaid credits to work and has its own pricing. To check an account’s | ||
| current balance or to buy more credits (:guilabel:`Recharge`), go to the | ||
| :menuselection:`Settings app --> Search "IAP" --> View My Services`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Each IAP service relies on prepaid credits to work and has its own pricing. To check an account’s | |
| current balance or to buy more credits (:guilabel:`Recharge`), go to the | |
| :menuselection:`Settings app --> Search "IAP" --> View My Services`. | |
| Each IAP service relies on prepaid credits to work and has its own pricing. To check an account’s | |
| current balance or to buy more credits (:guilabel:`Recharge`), go to the :menuselection:`Settings | |
| app --> Search "IAP" --> View My Services`. |
the GUI labels and menu selections can be broken up.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make sure to fill out the 100 character line limit as best as possible
| :alt: General Settings and the In-App Purchases heading showing the View My Services button. | ||
|
|
||
| .. tip:: | ||
| Users who have the Enterprise version of Odoo Online get free credits to test IAP features. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you know the number of the basic free credits?
| To be notified when credits are low, go to the | ||
| :menuselection:`Settings app --> Search "IAP" --> View My Services`. Click on a service and check | ||
| the :guilabel:`Receive threshold warning` box. Enter a minimum credit amount in the | ||
| :guilabel:`Warning threshold` field. Finally, click :guilabel:`Change Email` and provide an email | ||
| address to be automatically notified when credits are at or below the :guilabel:`Warning threshold`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| To be notified when credits are low, go to the | |
| :menuselection:`Settings app --> Search "IAP" --> View My Services`. Click on a service and check | |
| the :guilabel:`Receive threshold warning` box. Enter a minimum credit amount in the | |
| :guilabel:`Warning threshold` field. Finally, click :guilabel:`Change Email` and provide an email | |
| address to be automatically notified when credits are at or below the :guilabel:`Warning threshold`. | |
| To be notified when credits are low, go to the :menuselection:`Settings app --> Search "IAP" --> | |
| View My Services`. Click on a service and check the :guilabel:`Receive threshold warning` box. Enter | |
| a minimum credit amount in the :guilabel:`Warning threshold` field. Finally, click :guilabel:`Change | |
| Email` and provide an email address to be automatically notified when credits are at or below the :guilabel:`Warning threshold`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
need to fill out the 100 character limit
|
@MaxKeilOdoo There are some build errors on this PR- it looks as if your on the wrong base branch somewhere along the line. I would touch base with @samueljlieber to correct these errors. 👍 |
9402328 to
4e9741c
Compare
|
Hi @tiku-odoo , I just pushed a second draft of this and need your review. That said, I ran into a few issues and could not complete the full work flow or find descriptions of a few of the IAP services. Please take a look when you can, but I would also like to hop on a quick call to discuss quickly patching in the missing content. Thank you, and please let me know if you have any further questions or suggestions. |
c9bb955 to
59f093f
Compare
59f093f to
821d82e
Compare
|
Hi @MaxKeilOdoo Based on the CI check errors, I think we'll need to cherry-pick your work into a new PR here. Runbot is building your feature branch on |
|
ATTENTION: I am closing this pr and continuing work in #7427 |
Updated grammar per [In-App Purchase (IAP)] Update ticket from DADE.
-Removed inactive hyperlink to “Buying Credits” section
-Updated grammar throughout: removed 2nd person
-Added and adjusted language to improve clarity throughout
-Changed titles to be sentence case
-Added alt text for all images
-Changed navigation instructions to use search function for ease of use
-Replaced first image to include Search bar per the updated instructions
-Adjusted formatting throughout for things like :guilabel: