Skip to content

Conversation

@brse-odoo
Copy link
Contributor

This PR is targeting the serial numbers doc in Odoo's Inventory documentation.

Performed complete rewrite to the document for 14.0 to be fwd-ported (targeted revision for 15.0 and 16.0 to follow).

  • Completely rewrote the .rst file and added example flows
  • Replaced and updated all screenshots
  • Doc is more robust and comprehensive than before

@brse-odoo brse-odoo self-assigned this Mar 22, 2023
@robodoo
Copy link
Collaborator

robodoo commented Mar 22, 2023

@C3POdoo C3POdoo requested a review from a team March 22, 2023 20:07
@brse-odoo
Copy link
Contributor Author

Hi @jero-odoo and @larm-odoo! Whichever of you two is available to do so, this PR is ready for round one of peer review. Thank you in advance!

@brse-odoo brse-odoo requested a review from jero-odoo March 23, 2023 15:08
Copy link
Contributor

@jero-odoo jero-odoo left a comment

Choose a reason for hiding this comment

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

@brse-odoo All set! Let me know if you have any questions.

@brse-odoo brse-odoo force-pushed the 14.0-inventory-update-serial-numbers-brse branch from 7e0eee1 to cd0fa19 Compare March 29, 2023 14:22
@brse-odoo
Copy link
Contributor Author

@StraubCreative This PR is ready for your final review.

@brse-odoo brse-odoo requested a review from a team April 17, 2023 18:37
@brse-odoo
Copy link
Contributor Author

Hi @odoo/us-doc-review, this PR is ready for a content review when one of you has a chance. Thank you!

Copy link
Contributor

@hojo-odoo hojo-odoo left a comment

Choose a reason for hiding this comment

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

Hey Brandon,

Good job on this. Let me know if you would like to discuss any of my suggestions.

Thanks,
hojo

Copy link
Contributor

@ksc-odoo ksc-odoo left a comment

Choose a reason for hiding this comment

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

hey @brse-odoo just finished my peer review of this doc. great work! If you have any questions, don't hesitate to reach out. Thanks!

@brse-odoo brse-odoo force-pushed the 14.0-inventory-update-serial-numbers-brse branch from cd0fa19 to 7e84934 Compare May 3, 2023 17:51
@brse-odoo brse-odoo removed the request for review from StraubCreative May 3, 2023 17:55
@brse-odoo
Copy link
Contributor Author

@StraubCreative This is ready for final review.

@brse-odoo brse-odoo requested a review from StraubCreative May 3, 2023 17:55
Copy link
Contributor

@StraubCreative StraubCreative left a comment

Choose a reason for hiding this comment

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

Hi @brse-odoo
Please fix all of the 100th character line break issues and tag me again.
Reminder after peer/doc review, tag @samueljlieber for technical review.
I shouldn't be seeing these 😉
Thanks.

@StraubCreative StraubCreative added the repeat designation for PRs worth a second look label May 9, 2023
@brse-odoo brse-odoo force-pushed the 14.0-inventory-update-serial-numbers-brse branch from 7e84934 to 30e79de Compare May 10, 2023 13:28
@brse-odoo
Copy link
Contributor Author

@StraubCreative The 100th character line breaks have been fixed. This is ready for final review

@brse-odoo brse-odoo requested a review from StraubCreative May 11, 2023 14:51
Copy link
Contributor

@StraubCreative StraubCreative left a comment

Choose a reason for hiding this comment

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

100th char line breaks
cc: @samueljlieber

@brse-odoo brse-odoo force-pushed the 14.0-inventory-update-serial-numbers-brse branch from 30e79de to f4260aa Compare May 15, 2023 18:53
@brse-odoo
Copy link
Contributor Author

I found a single 100th character error in this doc, fixed it, and pushed up the changes.

@samueljlieber If you could take a look for me and confirm everything looks good, I'd appreciate it. Thank you!

Copy link
Contributor

@samueljlieber samueljlieber left a comment

Choose a reason for hiding this comment

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

Hi @brse-odoo 👋 I have a handful of technical changes throughout this doc, please see my suggestions below. I highlighted some of the 100th char line breaks, as well as adding global doc paths, using menuselections, and icon formatting.

Please let me know if you have any questions, otherwise Im looking forward to taking a second look! Thank you 🙂

Copy/paste serial numbers from an Excel file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To copy and paste serial numbers from an existing *Excel* file, first populate an *Excel*
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we need to italicize Excel, curious on @StraubCreative 's thoughts here 🤔

Copy link
Contributor

Choose a reason for hiding this comment

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

Why not just say spreadsheet?
Does it have to be Excel (the MS product)?

@brse-odoo brse-odoo force-pushed the 14.0-inventory-update-serial-numbers-brse branch from f4260aa to 4cb3641 Compare May 17, 2023 13:22
@brse-odoo
Copy link
Contributor Author

@samueljlieber I believe I've addressed all the technical issues in this doc -- if you have the time, I'd appreciate another once-over from you to confirm it looks good. Thanks in advance!

Copy link
Contributor

@samueljlieber samueljlieber left a comment

Choose a reason for hiding this comment

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

Hi @brse-odoo thanks for the changes to this PR, on my second look I caught just a couple more items that I missed in my review previously. Overall I think this PR is ready for final review, so I will push the minor changes listed below and then tag this PR for review. Nice job, thank you! 🙂

Comment on lines +130 to +131
Copy link
Contributor

Choose a reason for hiding this comment

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

Icon formatting - It looks like my previous suggestion may not have formatted correctly in the GitHub suggestion - my appologies, this is the formatting I was proposing:

Suggested change
From here, click the :guilabel:`Additional Options` menu, represented by a `hamburger` icon (four
horizontal lines, located to the right of the :guilabel:`Unit of Measure` column in the
From here, click the :guilabel:`Additional Options` menu, represented by a :guilabel:`hamburger
(four horizontal lines)` icon, located to the right of the :guilabel:`Unit of Measure` column in the

Comment on lines +194 to +200
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove duplicate paragraphs

Suggested change
Once all product quantities have been assigned a serial number, click the :guilabel:`Confirm` button
to close the pop-up. Then, click :guilabel:`Validate`.
A :guilabel:`Traceability` smart button appears upon validating the receipt. Click the
:guilabel:`Traceability` smart button to see the updated :guilabel:`Traceability Report`, which
includes: a :guilabel:`Reference` document, the :guilabel:`Product` being traced, the
:guilabel:`Lot/Serial #`, and more.

Copy link
Contributor

Choose a reason for hiding this comment

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

Icon formatting again :)

Suggested change
From here, click the :guilabel:`Additional Options` menu, represented by a `hamburger` icon (four
horizontal lines, located to the right of the :guilabel:`Unit of Measure` column in the
From here, click the :guilabel:`Additional Options` menu, represented by a :guilabel:`hamburger
(four horizontal lines)` icon, located to the right of the :guilabel:`Unit of Measure` column in the

@samueljlieber samueljlieber force-pushed the 14.0-inventory-update-serial-numbers-brse branch from 4cb3641 to 2aa6463 Compare May 17, 2023 14:16
@samueljlieber
Copy link
Contributor

Implemented technical changes in 2aa6463, @StraubCreative this PR is ready for your review 👍

Copy link
Contributor

@StraubCreative StraubCreative left a comment

Choose a reason for hiding this comment

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

Hi @brse-odoo
Nice work. Very thorough and descriptive.
I have some suggestions for your consideration below, however, I think we're also good to merge right away, if you prefer.
Either way, passing the baton to you 🔥
Note: you can make Odoo 16 updates (e.g. language around click Save, etc.) on the FWP PRs if you'd like, or can create new PRs manually. Also up to you!

@robodoo delegate+

@StraubCreative
Copy link
Contributor

Quick follow-up @brse-odoo
serial-numbers-auto-assign-sn.png and serial-numbers-detailed-operations-popup.png are fine, technically, however the forms, presented as they are with so many line items, take up a lot of real-estate on the page. You could cut those line items down and still communicate the value around the form fields at the top.

@brse-odoo brse-odoo force-pushed the 14.0-inventory-update-serial-numbers-brse branch from 2aa6463 to 0493eb9 Compare May 22, 2023 13:25
@brse-odoo
Copy link
Contributor Author

@robodoo r+

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

Labels

repeat designation for PRs worth a second look

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants