[IMP] VoIP: Devices + Integrations Revamp #13002
Conversation
|
|
f665b68 to
058ba28
Compare
|
|
||
| Odoo *VoIP* is SIP (Session Initiation Protocol) compatible, which means it can be used with *any* | ||
| :abbr:`SIP (Session Initiation Protocol)` compatible application. | ||
| While |VOIP| is available on Odoo's desktop experience, it can also be used through the Odoo mobile |
There was a problem hiding this comment.
link doc for more info on mobile apps
| support tickets. | ||
| Odoo |VOIP| is fully integrated with the **Contacts**, **CRM**, **Sales**, and **Helpdesk** apps. | ||
| While the benefits are most clearly felt when using |VOIP| from the Odoo database, it can also be | ||
| used from apps like the ones covered below. |
There was a problem hiding this comment.
Highly optional, but I would list the apps rather than use a spatial reference, since doc things move around with time
| calls. If the user needs to be reachable on a mobile device at all times, an app, like Zoiper, | ||
| should be used. Apps like that stay connected in the background at all times. | ||
| Using |VOIP| through the Odoo mobile app or through a third-party tool still requires a |VOIP| | ||
| service provider. Learn more about signing a :doc:`VoIP service provider <../voip>`. |
There was a problem hiding this comment.
Move to a "see more" admonition or finish the sentence with a prepositional phrase so it's not just a command to learn
| Odoo mobile apps are no longer supported by Odoo. Learn more about :doc:`Odoo's mobile apps | ||
| <../../../administration/mobile>`. |
There was a problem hiding this comment.
Does this contradict the first sentence encouraging you to use mobile apps? I assume this is distinguishing the PWA app from some deprecated one but for the average user this looks like it would be confusing.
| This step is **necessary**, regardless of whether the mobile Odoo application or web browser is | ||
| used. |
There was a problem hiding this comment.
admonition and specify what it blocks
content/applications/productivity/voip/devices_integrations.rst
Outdated
Show resolved
Hide resolved
content/applications/productivity/voip/devices_integrations.rst
Outdated
Show resolved
Hide resolved
content/applications/productivity/voip/devices_integrations.rst
Outdated
Show resolved
Hide resolved
| *Linphone* IOS application. Screenshots and steps may differ depending on the circumstances. | ||
| Download the *Linphone* app from either the `Google Play Store | ||
| <https://play.google.com/store/apps/details?id=org.linphone>`_ or the `Apple App Store | ||
| <https://apps.apple.com/us/app/linphone/id360065638>`_ (depending on the device's operating system) |
There was a problem hiding this comment.
You probably don't need to explain that it depends on OS in this day and age
| Download the *Linphone* app from either the `Google Play Store | ||
| <https://play.google.com/store/apps/details?id=org.linphone>`_ or the `Apple App Store | ||
| <https://apps.apple.com/us/app/linphone/id360065638>`_ (depending on the device's operating system) | ||
| to begin using *Linphone*. This article will cover setting up *Linphone* for an iOS device while |
There was a problem hiding this comment.
The article thing again. Like maybe these should just actually be fully separate docs?
Co-authored-by: Zaz Linkous <ZazLinkous@gmail.com>
cc373c7 to
3d863a9
Compare
|
@Felicious ready for review |
There was a problem hiding this comment.
Hi @justinmallette — thank you for sharpening the prose and stripping out the sales copy from the 16.0 draft. The text now reads much cleaner! That said, a few new ambiguities crept in, and there are some key gaps to address before I can approve:
- Add screenshots: Customers depend on step-by-step visuals, in addition to instructions. Please go through the Zoiper Lite and Linphone setups, capture fresh screenshots, and drop them in.
- Specificity: Some directions are vague (e.g. how Avivox is used, where can the user account be found). Re-run the flows and add the exact instructions so users can follow without guessing.
- Odoo link-back: Zoiper Lite/Linphone are positioned as “alternatives,” but the doc doesn’t show how they connect to Odoo VoIP. Clarify the integration or reconsider including them.
- Point value: Given the missing visuals, unclear Odoo tie-in, and length of the doc, I’m marking this at 3 points for now. Happy to revisit after the above fixes.
Ping me if anything’s unclear, and thanks again for the rewrite work so far!
| ============================= | ||
| VoIP devices and integrations | ||
| ============================= |
There was a problem hiding this comment.
Appreciate the effort to improve the readability of this doc compared to the ~16.0 version. The revised article has clearer and more concise writing, and it removes "sales-y benefits" from configuration steps that was present in the original. That said, a few new ambiguities crept in and some helpful context was trimmed. There are also areas where we can further improve for brevity. Let's revisit the areas pointed out in this review and ensure the doc has the necessary amounts of specificity as defined in our quality matrix.
| .. seealso:: | ||
| To see how to use the :abbr:`VoIP (Voice over Internet Protocol)` widget on a desktop/laptop | ||
| computer, check out this documentation: :doc:`voip_widget`. | ||
|
|
||
| Odoo VoIP (tablet/mobile device) | ||
| ================================ | ||
| Using |VOIP| through the Odoo mobile app or through a third-party tool still requires a |VOIP| | ||
| service provider. Learn more about signing a :doc:`VoIP service provider <../voip>`. |
There was a problem hiding this comment.
Seealso blocks should only include link text and doc links. Let's condense this into 5 words maximum
| Odoo mobile apps available in app stores are no longer supported by Odoo. Learn more about | ||
| :doc:`Odoo's mobile apps <../../../administration/mobile>`. |
There was a problem hiding this comment.
The sentence repeats “mobile apps” twice in fewer than ten words. Here are a couple of tighter options you can drop in:
- Sentence-case, warning style
Danger
Odoo’s iOS and Android apps are no longer supported. [Learn more.]
- Inline note
Odoo recommends using a mobile browser to access a database, rather than the mobile apps, as Odoo no longer maintains its iOS or Android apps.
Either version keeps the critical information while removing the echo.
| :guilabel:`Allow` the database to use the microphone. Click :guilabel:`Allow` when prompted to | ||
| continue with the call using the microphone. | ||
| To make a call through the Odoo mobile app, first tap the :icon:`oi-voip` :guilabel:`VoIP` icon at | ||
| the top of the screen. From here, the |VOIP| widget will appear on the screen. After that, the user |
There was a problem hiding this comment.
can remove the future case, "will"
|
|
||
| This step is **necessary**, whether using the mobile Odoo application or web browser. | ||
| - Enter the phone number to be called by clicking the :icon:`fa-keyboard` :guilabel:`(keyboard)` |
There was a problem hiding this comment.
the keyboard icon isn't rendering for some reason 🤔
| *Linphone* is a third-party alternative to Odoo |VOIP|. It is a free |VOIP| |SIP| dialer with voice, | ||
| video, messaging (direct messages and group chats), and can support conference calls. |
There was a problem hiding this comment.
Again, if it's an alternative to Odoo, how is this related to us? Is it because we can also integrate with other Odoo apps? Let's clarify that integration
|
|
||
| To begin configuring *Linphone* for use with a :abbr:`SIP (Session Initiation Protocol)` provider, | ||
| first open *Linphone*, and an assistant screen appears. | ||
| Once *Linphone* is installed on the mobile device, open the app and tap on :icon:`fa-bars` |
There was a problem hiding this comment.
The phrase “tap on ” reads incomplete—consider “tap on the icon” for clearer grammar.
| <https://apps.apple.com/us/app/linphone/id360065638>`_. This section will cover setting up | ||
| *Linphone* for an iOS device while using :doc:`Axivox <axivox/axivox_config>` as the |VOIP| service | ||
| provider, so the experience may differ for other operating systems or |VOIP| service providers. |
There was a problem hiding this comment.
It’s unclear where Axivox fits into the flow. We say “using Axivox as the VoIP provider,” but never show when or where to obtain and enter the Axivox SIP credentials. Could you:
-
Add a brief prerequisite (“Create an Axivox SIP account in the Axivox portal and copy the SIP username, password, and domain”), or
-
Link to existing Axivox-setup docs and specify exactly where those credentials are pasted in Linphone?
That context will help readers complete the configuration without guessing.
| :guilabel:`Domain`, :guilabel:`Username`, and :guilabel:`Password`. All this information varies, | ||
| based on the account. | ||
| Once all of this information is entered, tap the green :guilabel:`Register` button at the top of the | ||
| screen. *Zoiper* will confirm the information, then show a message saying :guilabel:`Registration |
There was a problem hiding this comment.
It looks like “Lite” was dropped from Zoiper Lite here—intentional, or should we add it back? 🤔
| Odoo then asks how to make the call. The two options are to either use |VOIP| or use the phone's | ||
| connection. Click the box next to :guilabel:`Remember ?` should this decision be the default moving | ||
| forward. |
There was a problem hiding this comment.
possible rewrite for brevity
| Odoo then asks how to make the call. The two options are to either use |VOIP| or use the phone's | |
| connection. Click the box next to :guilabel:`Remember ?` should this decision be the default moving | |
| forward. | |
| Odoo then prompts for a call method: VoIP or the device’s cellular connection. Select Remember? to set the chosen option as the default. |
Note: Didn't format so remember to do so in your revision!
Overhauled devices and integrations doc to match styling, flow, and platform accuracy.
Task: https://www.odoo.com/odoo/project/3835/tasks/4744593