Skip to content

[IMP] barcode: split docs + hone in on language #5592

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

[IMP] barcode: split docs + hone in on language #5592

wants to merge 1 commit into from

Conversation

@Felicious
Copy link
Contributor

@Felicious Felicious commented Aug 24, 2023 •
edited
Loading

Summary

Improve wording about GS1 barcode concepts.

  • Received feedback from CRU about barcode conceptual accuracy and changed the wording to reflect it
  • Created scannable 2D matrix barcodes (they look like QR codes) for readers to try scanning!
  • Received feedback from hojo to split the docs into two so it's easier for readers to search for GS1 nomenclature (setup) vs. using GS1 barcodes in their warehouse workflow.
  • Received feedback from ZST about honing in on language surrounding creating GS1 barcodes. Need to make it very clear that Odoo doesn't generate GS1 barcodes for users! We just take in their inputs. Can reviewers make sure that my doc makes this very clear? (:

Thanks 😸

@Felicious Felicious requested a review from hojo-odoo August 24, 2023 02:04
@Felicious Felicious self-assigned this Aug 24, 2023
@Felicious Felicious marked this pull request as draft August 24, 2023 02:04
@robodoo
Copy link
Collaborator

robodoo commented Aug 24, 2023

Pull request status dashboard.

@Felicious Felicious force-pushed the 15.0-barcode-GTIN-specifics branch from 5462ac8 to 73cd088 Compare August 24, 2023 22:20
@Felicious Felicious marked this pull request as ready for review August 24, 2023 22:21
@C3POdoo C3POdoo requested a review from a team August 24, 2023 22:22
@Felicious Felicious force-pushed the 15.0-barcode-GTIN-specifics branch 2 times, most recently from 926cee4 to 746d9a1 Compare August 25, 2023 16:20
@brse-odoo brse-odoo self-requested a review October 11, 2023 18:28
brse-odoo
brse-odoo reviewed Oct 16, 2023
View reviewed changes
Copy link
Contributor

@brse-odoo brse-odoo left a comment

Choose a reason for hiding this comment

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

@Felicious I've just finished my review of this doc, great work! I left suggestions for grammar/clarity, so feel free to ask me about any of them, as always. Thanks!

@Felicious Felicious force-pushed the 15.0-barcode-GTIN-specifics branch from a033d87 to aa49c98 Compare November 9, 2023 22:46
@Felicious Felicious requested a review from brse-odoo November 9, 2023 22:47
@Felicious
Copy link
Contributor Author

Felicious commented Nov 9, 2023

Hi @brse-odoo ! This PR is ready for your second review (: I rewrote the intro of the barcode usage doc, as per your input. Let me know if it's an improvement towards the direction you were pointing in!

Thank you :D

@StraubCreative StraubCreative requested review from a team and removed request for hojo-odoo November 14, 2023 00:29
StraubCreative
StraubCreative requested changes Nov 14, 2023
View reviewed changes
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 @Felicious
A couple necessary + optional change requests below.
I like the QR code examples, very clever 😉

Think this PR should be good to ship on next commit.
Thanks!

content/applications/inventory_and_mrp/inventory/barcode/operations/gs1_usage.rst Outdated
.. |AI| replace:: :abbr:`A.I. (Application Identifier)`
.. |GTIN| replace:: :abbr:`GTIN (Global Trade Item Number)`

GS1 barcodes are a standardized language for barcode scanners helping businesses with international
Copy link
Contributor

@StraubCreative StraubCreative Nov 14, 2023

Choose a reason for hiding this comment

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

  • singular/plural mismatch
  • language is the wrong word here I think?
  • this first sentence is a bit clunky 🥴

Copy link
Contributor Author

@Felicious Felicious Nov 15, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

what do u think about my intro rewrite?

GS1 barcodes provide a standardized format that barcode scanners can interpret. They encode
information in a :ref:specific structure recognized globally <barcode/operations/gs1>, allowing
scanners to understand and process supply chain data consistently.

Odoo Barcode interprets and prints GS1 barcodes, automating product identification and tracking
in warehouse operations such as receiving, picking, and shipping.

Copy link
Contributor

@StraubCreative StraubCreative Nov 15, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

good rewrite
one revision:
specific structure recognized globally --> specific, globally recognized structure

@Felicious @samueljlieber
@brse-odoo @StraubCreative
[IMP] barcode: split docs + hone in on language
89824ed 
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
Co-authored-by: brse-odoo <brse@odoo.com>
Co-authored-by: Zachary Straub <zst@odoo.com>
@Felicious Felicious force-pushed the 15.0-barcode-GTIN-specifics branch from ca5d5b8 to 89824ed Compare November 15, 2023 19:22
StraubCreative
StraubCreative approved these changes Nov 16, 2023
View reviewed changes
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.

Looks good @Felicious, nice work 🚀

@robodoo r+

@robodoo
Copy link
Collaborator

robodoo commented Nov 16, 2023

@Felicious @StraubCreative staging failed: ci/runbot on e178c90fbbbd7faab27245888e8bac7ef080a465 (view more at https://runbot.odoo.com/runbot/build/53771737)

@StraubCreative
Copy link
Contributor

StraubCreative commented Nov 16, 2023

@robodoo retry

robodoo pushed a commit that referenced this pull request Nov 16, 2023
@Felicious @samueljlieber
@brse-odoo @StraubCreative
[IMP] barcode: split docs + hone in on language
e7cd792 
closes #5592

Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
Co-authored-by: brse-odoo <brse@odoo.com>
Co-authored-by: Zachary Straub <zst@odoo.com>
@robodoo robodoo closed this Nov 16, 2023
This was referenced Nov 16, 2023
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@samueljlieber samueljlieber samueljlieber left review comments

@StraubCreative StraubCreative StraubCreative approved these changes

@brse-odoo brse-odoo Awaiting requested review from brse-odoo

Assignees

@Felicious Felicious

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@Felicious @robodoo @StraubCreative @samueljlieber @brse-odoo