[IMP] iot: esc-pos ESC * support documentation #5367

lse-odoo · 2023-08-08T16:12:02Z

Documentation regarding the fix:
odoo/odoo#126689

opw-3351084,3341907

robodoo · 2023-08-08T16:12:48Z

tiku-odoo · 2023-08-14T21:30:06Z

This doc is ready for 1st round of technical/ settings documentation review. It is pretty technical. Can you give it a good review (as much as you can functionally) and style/grammar/rst? Thanks for your help on this doc.

Thanks in advance for your help, and I look forward to your suggestions.

Tim 👍

CC: @lse-odoo (I've made formatting/style changes while trying to stay true to the technical process. Can you review it for accuracy (technical)? I will move moving it along with the review process now. Thank you.

lse-odoo

@tiku-odoo some feedbacks. Most of them are just opinion, feel free to ignore them if you think they are unjustified or argue

content/applications/productivity/iot/config/troubleshooting.rst

tiku-odoo · 2023-08-16T18:33:57Z

@lse-odoo

I've made your requested changes. Thanks for your review, unless you would like another look. @Felicious will be reviewing, during this doc's 1st round of peer reviews.

Thanks for your continued hard work on this doc.

Tim 👍

Felicious

Just finished going through my first reading of your doc, @tiku-odoo ! 😄

It's amazing that you're writing us documentation on such a complex topic. I made some notes about the convention we use some certain admonition blocks, as well as some wording and structural suggestions. The goal is to help the reader skip to the section they're looking for! 😄

Let me know if you have any questions about my comments, and re-request me to review again when you're done accepting/rejecting my suggestions. I'd be more than happy to look it over once more!

Felicious · 2023-08-16T21:28:15Z

content/applications/productivity/iot/config/troubleshooting.rst

@@ -99,6 +99,230 @@ Printer`. Follow the steps and select the *make* and *model* corresponding to th
   Epson and Star receipt printers and Zebra label printers do not need a driver to work. Make sure
   that no driver is selected for those printers.

+Epson special case


I'm not able to make comments on line 1, but what do you think about adding a table of contents for all the FAQ q's u go over in this doc, Tim? I guess I'm not used to not seeing some sort of intro paragraph at the beginning of the doc 😂

If you choose to make a table of contents, might I suggest using the custom admonition block, and creating custom anchors to each of the questions ?

content/applications/productivity/iot/config/troubleshooting.rst

tiku-odoo · 2023-08-21T15:25:00Z

Just finished going through my first reading of your doc, @tiku-odoo ! 😄

It's amazing that you're writing us documentation on such a complex topic. I made some notes about the convention we use some certain admonition blocks, as well as some wording and structural suggestions. The goal is to help the reader skip to the section they're looking for! 😄

Let me know if you have any questions about my comments, and re-request me to review again when you're done accepting/rejecting my suggestions. I'd be more than happy to look it over once more!

Hey @Felicious, Thanks for your thorough review. The IoT grouping of docs was last updated at the end of Q2 (2023) under this PR: #3673

At this time, we will just be making edits to lines 102-325 - thanks so much for your requested edits outside of these lines. They are excellent. I'm sorry I didn't specify the specific lines in my previous comment to you.

I will be making edits those lines. Thanks in advance for your help on this! Great work 👍

tiku-odoo · 2023-08-21T17:41:44Z

@odoo/helpdesk-doc-review

This doc is ready for your review.

Ignore the H7 build errors.

Thanks in advance for your help on this doc.

Lines 102-342.

Tim 👍

jero-odoo

All set, let me know if you have any questions 👍

content/applications/productivity/iot/config/troubleshooting.rst

tiku-odoo · 2023-08-22T16:18:44Z

@odoo/us-doc-review

This doc is ready for your review.

The IoT grouping of docs was recently updated in PR# #3673

The only section that needs to be reviewed here are:
Lines 102-342

I have incorporated H7 headings into this doc as they nicely add to the structure and table of contents. They allow the customer to jump to sections from the table of contents. However, the H7 headings produce build errors (although the page is built OK).

Another thing that I did was incorporate a spoiler admonition block to hide a detailed example of the printer configuration, as this is a big doc.

Thanks in advance for your help on this.

Tim 👍

tiku-odoo · 2023-09-20T14:06:47Z

@meng-odoo This doc is ready for your review... Thanks! 👍

StraubCreative

Some comments below (but not all) which I'll address in another commit.

I'd like to clean this doc up in another PR and expand on the concepts more, if and where possible (which might be a good Task for @Felicious if you're up for it 😉). The content comes across as short-handed and fast-paced, which certainly works for users who are already operating at an intermediate or expert level, however it's not very inviting to new users who may not be familiar with the terminology.

That being said the content additions here are certainly relevant so will merge after pushing up changes 👍

Reminder for the future as well: image names should be in lowercase letters.

StraubCreative · 2023-10-07T00:59:51Z

content/applications/productivity/iot/config/troubleshooting.rst

+Epson printer compatibility
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The first step is to check whether the printer is incompatible with `GS v 0` command.


Suggested change

The first step is to check whether the printer is incompatible with `GS v 0` command.

The first step is to check whether the printer is incompatible with the `GS v 0` command.

StraubCreative · 2023-10-07T01:03:34Z

content/applications/productivity/iot/config/troubleshooting.rst

+.. seealso::
+   See this `Epson's GS v 0 documentation
+   <https://reference.epson-biz.com/modules/ref_escpos/index.php?content_id=94>`_ for `GS v 0`
+   compatible printers.
+
+   See this `Epson ESC * documentation
+   <https://reference.epson-biz.com/modules/ref_escpos/index.php?content_id=88>`_ for `ESC *`
+   compatible printers.


Suggested change

.. seealso::

See this `Epson's GS v 0 documentation

<https://reference.epson-biz.com/modules/ref_escpos/index.php?content_id=94>`_ for `GS v 0`

compatible printers.

See this `Epson ESC * documentation

<https://reference.epson-biz.com/modules/ref_escpos/index.php?content_id=88>`_ for `ESC *`

compatible printers.

.. seealso::

- `Epson GS v 0 documentation <https://reference.epson-biz.com/modules/ref_escpos/index.php?

content_id=94>`_ for `GS v 0` compatible printers.

- `Epson ESC * documentation <https://reference.epson-biz.com/modules/ref_escpos/index.php

?content_id=88>`_ for `ESC *` compatible printers.

StraubCreative · 2023-10-07T01:05:47Z

content/applications/productivity/iot/config/troubleshooting.rst

+To configure the :abbr:`IoT (Internet of Things)` box to use the `ESC *` command to print, go to the
+:abbr:`IoT (Internet of Things)` box homepage. Access the :abbr:`IoT (Internet of Things)` box
+homepage by navigating to :menuselection:`IoT app --> IoT Boxes`. Then click on the :guilabel:`IP
+address` and this will redirect the page to the :abbr:`IoT (Internet of Things)` box homepage.


Suggested change

To configure the :abbr:`IoT (Internet of Things)` box to use the `ESC *` command to print, go to the

:abbr:`IoT (Internet of Things)` box homepage. Access the :abbr:`IoT (Internet of Things)` box

homepage by navigating to :menuselection:`IoT app --> IoT Boxes`. Then click on the :guilabel:`IP

address` and this will redirect the page to the :abbr:`IoT (Internet of Things)` box homepage.

To configure the :abbr:`IoT (Internet of Things)` box to use the `ESC *` command to print, go to the

:abbr:`IoT (Internet of Things)` box homepage by navigating to :menuselection:`IoT app --> IoT

Boxes`. Then click on the :guilabel:`IP address` and this will direct to the :abbr:`IoT (Internet of

Things)` box homepage.

content/applications/productivity/iot/config/troubleshooting.rst

StraubCreative · 2023-10-07T01:09:32Z

content/applications/productivity/iot/config/troubleshooting.rst

+Now click on the :guilabel:`Printers server` button. This will redirect the browser to the *CUPS
+page*. Next, go to :menuselection:`Administration --> Printers --> Add Printer`. Now choose the
+printer that should be modified and click :guilabel:`Continue`.


Suggested change

Now click on the :guilabel:`Printers server` button. This will redirect the browser to the *CUPS

page*. Next, go to :menuselection:`Administration --> Printers --> Add Printer`. Now choose the

printer that should be modified and click :guilabel:`Continue`.

Now click on the :guilabel:`Printers server` button. This will redirect the browser to the *CUPS*

page. Next, go to :menuselection:`Administration --> Printers --> Add Printer`, choose the printer

that should be modified, and then click :guilabel:`Continue`.

StraubCreative · 2023-10-07T01:10:27Z

content/applications/productivity/iot/config/troubleshooting.rst

+   #. Turn the printer off and refresh the page.
+   #. Now compare the difference with the first list to see which printer disappeared.
+   #. Turn the printer back on and refresh the page again.
+   #. Double check the list again to see if the printer re-appears.


Suggested change

#. Double check the list again to see if the printer re-appears.

#. Double-check the list again to see if the printer re-appears.

StraubCreative · 2023-10-07T01:15:12Z

content/applications/productivity/iot/config/troubleshooting.rst

+   too big or small) it cannot be modified via the printer name with *CUPS*. Instead, the above
+   process can be repeated to set up another printer from scratch to create one with modified


Suggested change

too big or small) it cannot be modified via the printer name with *CUPS*. Instead, the above

process can be repeated to set up another printer from scratch to create one with modified

too big or small), then it cannot be modified via the printer name with *CUPS*. Instead, the

above process can be repeated to set up another printer from scratch to create one with modified

StraubCreative · 2023-10-07T01:35:31Z

content/applications/productivity/iot/config/troubleshooting.rst

+Example setup of the Epson TM-U220B printer using ESC *
+"""""""""""""""""""""""""""""""""""""""""""""""""""""""


The content in this section is relevant however it's a bit ugly and breaks on mobile.

Would like to revisit the use of quotation marks as "h7" formatting—

Typically headings only go down to h6 which are normally associated with subtext (think footer links), so we'd need to create a specific style for this if we were to use it.

As it is, out of the box, the use of quotation mark symbols is reserved to indicate paragraph text in Sphinx.

...so it might actually just be better to use bold text because, as it is now, the " formatting doesn't render anything visually unique enough to say to the reader "hey I'm a heading!"

Also we cannot merge the doc with invalid characters like this as the error will propagate to all other versions of the doc across multiple versions (in effect, replicating an error).

Will replace with bold text for now.

Documentation regarding the fix: odoo/odoo#126689 opw-3351084,3341907 Authored by: lse-odoo <lse@odoo.com> Co-authored by: tiku-odoo <tiku@odoo.com> Co-authored by: Felicious <feku@odoo.com> Co-authored by: jero-odoo <jero@odoo.com> Signed-off-by: StraubCreative <zst@odoo.com>

StraubCreative · 2023-10-07T02:48:10Z

fbd613f: final review change requests + image rename prep

713e812: image rename execution + squash commits

810b7f7: update image paths in RST

StraubCreative

@robodoo r+

Documentation regarding the fix: odoo/odoo#126689 opw-3351084,3341907 Authored by: lse-odoo <lse@odoo.com> Co-authored by: tiku-odoo <tiku@odoo.com> Co-authored by: Felicious <feku@odoo.com> Co-authored by: jero-odoo <jero@odoo.com> closes #5367 Signed-off-by: StraubCreative <zst@odoo.com> Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

lse-odoo requested a review from tiku-odoo August 8, 2023 16:12

C3POdoo requested a review from a team August 8, 2023 16:13

lse-odoo force-pushed the 15.0-iot_escpos_esc_star_usage-lse branch from afcb6b4 to dafe168 Compare August 9, 2023 09:47

tiku-odoo force-pushed the 15.0-iot_escpos_esc_star_usage-lse branch from dafe168 to be24ca6 Compare August 14, 2023 21:21

tiku-odoo assigned tiku-odoo and lse-odoo Aug 14, 2023

tiku-odoo requested review from hojo-odoo and Felicious and removed request for hojo-odoo August 14, 2023 21:23

lse-odoo commented Aug 16, 2023

View reviewed changes

tiku-odoo force-pushed the 15.0-iot_escpos_esc_star_usage-lse branch from be24ca6 to e964601 Compare August 16, 2023 18:33

Felicious requested changes Aug 16, 2023

View reviewed changes

tiku-odoo force-pushed the 15.0-iot_escpos_esc_star_usage-lse branch from e964601 to 65ab278 Compare August 21, 2023 16:35

jero-odoo requested changes Aug 22, 2023

View reviewed changes

tiku-odoo force-pushed the 15.0-iot_escpos_esc_star_usage-lse branch from 65ab278 to 28648f4 Compare August 22, 2023 15:57

tiku-odoo requested a review from a team September 20, 2023 14:07

tiku-odoo requested a review from meng-odoo October 6, 2023 20:16

StraubCreative requested changes Oct 7, 2023

View reviewed changes

StraubCreative force-pushed the 15.0-iot_escpos_esc_star_usage-lse branch 2 times, most recently from fbd613f to 713e812 Compare October 7, 2023 02:36

StraubCreative force-pushed the 15.0-iot_escpos_esc_star_usage-lse branch from 713e812 to 810b7f7 Compare October 7, 2023 02:45

StraubCreative approved these changes Oct 7, 2023

View reviewed changes

robodoo temporarily deployed to merge October 7, 2023 03:47 Inactive

fw-bot mentioned this pull request Oct 7, 2023

[FW][IMP] iot: esc-pos ESC * support documentation #6059

Closed

robodoo closed this Oct 7, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[IMP] iot: esc-pos ESC * support documentation #5367

[IMP] iot: esc-pos ESC * support documentation #5367

lse-odoo commented Aug 8, 2023

robodoo commented Aug 8, 2023

tiku-odoo commented Aug 14, 2023

lse-odoo left a comment

tiku-odoo commented Aug 16, 2023

Felicious left a comment

Felicious Aug 16, 2023

tiku-odoo commented Aug 21, 2023 •

edited

Loading

tiku-odoo commented Aug 21, 2023

jero-odoo left a comment

tiku-odoo commented Aug 22, 2023

tiku-odoo commented Sep 20, 2023

StraubCreative left a comment •

edited

Loading

StraubCreative Oct 7, 2023

StraubCreative Oct 7, 2023

StraubCreative Oct 7, 2023

StraubCreative Oct 7, 2023

StraubCreative Oct 7, 2023

StraubCreative Oct 7, 2023

StraubCreative Oct 7, 2023

StraubCreative Oct 7, 2023

StraubCreative Oct 7, 2023

StraubCreative commented Oct 7, 2023

StraubCreative left a comment

	The first step is to check whether the printer is incompatible with `GS v 0` command.
	The first step is to check whether the printer is incompatible with the `GS v 0` command.

	#. Double check the list again to see if the printer re-appears.
	#. Double-check the list again to see if the printer re-appears.

		too big or small) it cannot be modified via the printer name with CUPS. Instead, the above
		process can be repeated to set up another printer from scratch to create one with modified

		Example setup of the Epson TM-U220B printer using ESC *
		"""""""""""""""""""""""""""""""""""""""""""""""""""""""

[IMP] iot: esc-pos ESC * support documentation #5367

[IMP] iot: esc-pos ESC * support documentation #5367

Conversation

lse-odoo commented Aug 8, 2023

robodoo commented Aug 8, 2023

tiku-odoo commented Aug 14, 2023

lse-odoo left a comment

Choose a reason for hiding this comment

tiku-odoo commented Aug 16, 2023

Felicious left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tiku-odoo commented Aug 21, 2023 • edited Loading

tiku-odoo commented Aug 21, 2023

jero-odoo left a comment

Choose a reason for hiding this comment

tiku-odoo commented Aug 22, 2023

tiku-odoo commented Sep 20, 2023

StraubCreative left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StraubCreative commented Oct 7, 2023

StraubCreative left a comment

Choose a reason for hiding this comment

tiku-odoo commented Aug 21, 2023 •

edited

Loading

StraubCreative left a comment •

edited

Loading