-
Notifications
You must be signed in to change notification settings - Fork 10.8k
[IMP] Inventory: updating second person and images, add clarity #3787
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
Conversation
|
@hojo-odoo @Felicious @brse-odoo same here can one of you review and then tag @odoo/us-doc-review ? |
Felicious
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.
Hi Lara! This was a really well-written doc 😊
I only have minor suggestions including:
- Adding one or two headings so people can skip to sections they're looking for easier
- Moving the
see alsosection to when units of measure is mentioned in the text - Changing the external reference from
:doc:-->:ref:so the link has a lesser chance of breaking - Adding
:in front of an:abbr:tag - Specifying the location of the Detailed operations icon on the product form
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
6b5ad8b to
43886bc
Compare
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
Felicious
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.
Hi Lara! Just wanted to say it was such an informative read (:
43886bc to
1610ece
Compare
larm-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.
I agree with all your changes and think they are very helpful to the users- thank you for making this doc better!
1610ece to
403615d
Compare
403615d to
df8f8b8
Compare
Reviewed and tagged! (: |
ksc-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.
@larm-odoo Hi There! Just finished my Peer Review of this doc - Great job! If you have any questions or need clarification on anything, don't hesitate to reach out. Thanks!
content/applications/inventory_and_mrp/inventory/barcode/setup/software.rst
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
df8f8b8 to
0ac7730
Compare
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
ksc-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.
@Felicious just gave this another look - and I totally understand what you mean re: the lengthy example block. I left some feedback, but whatever route you choose, I think it's smart to add this info to the doc. Some users may find it super helpful! Great job! If you have any other questions, or need clarification on anything, just let me know.
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
a7c0852 to
20c8bde
Compare
20c8bde to
e2553f4
Compare
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.
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.
yea these are the values of inputs (not headings, labels, etc.) so they'd receive single back ticks, not guis
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.
I see - I misunderstood. My point of thinking was I thought these units were selections from the Unit of Measure field on the product form, and not a literal input of text "ft".
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.
Thanks for reminding me, Sam (: You made a good point about checking exactly what the UI displays, so I rewrote the section to match quantities that appears on the product form and PO.

| The product, `Rope` has its :guilabel:`Unit of Measure` field set to feet (:guilabel:`ft`) and | |
| its :guilabel:`Purchase UoM` set to centimeters (:guilabel:`cm`). When creating a :abbr:`PO | |
| (Purchase Order)` for the product, the :guilabel:`Purchase UoM (Unit of Measure)`, centimeters | |
| (:guilabel:`cm`), appears on the form to measure the quantity of rope the company buys from the | |
| On the product form for `Rope`, the following fields are set as: | |
| - :guilabel:`Unit of Measure` in `ft` (feet), and | |
| - :guilabel:`Purchase UoM` in `cm` (centimeters). | |
| Because the vendor sells rope in `cm`, the purchase :guilabel:`UoM ` is used to represent the | |
| quantity on the :abbr:`PO (Purchase Order)`. |
1194c17 to
e026a63
Compare
|
Hi @samueljlieber ! I know you said I could proceed, but I had one more thing I was slightly confused about, and I wanted to ask you what you thought. So so grateful that you could give this one more look (: |
e026a63 to
64f4661
Compare
|
Hi @Felicious your changes look good to me! I think the rewording clears things up nicely, thank you for taking the time to do that :) |
64f4661 to
974a693
Compare
|
Hi @StraubCreative! This PR originally written by Lara is ready for your review (: |
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.
Hi @Felicious and @larm-odoo
Nice work.
I have a few changes for your consideration below.
Tag me again when we're ready for another look, thanks!
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Show resolved
Hide resolved
| ------------------- | ||
|
|
||
| To view all packagings that have been created, go to :menuselection:`Inventory app --> Configuration | ||
| --> Product Packagings`. Doing so reveals a separate page with a complete list of all packagings |
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.
does this "separate page" have a name?
Also, is it a page, or a dashboard?
it's better to be specific on things like this...
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
eadb30a to
86808df
Compare
|
Wow, I lost track of this doc for a month! Thanks for the initial look and comments, @StraubCreative 😸 I made some changes and this doc is ready for another look! Thank you (: |
StraubCreative
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.
Hi @Felicious
Really well written. The examples are great.
Approving with comments for you to optionally address now or later, if you choose.
Run the merge command whenever you're ready
@robodoo delegate=Felicious
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
| (Sales Order)` line. This opens the :guilabel:`Detailed Operations` window with an editable table to | ||
| specify which products are intended for which package. | ||
|
|
||
| .. example:: |
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.
Can continue to update this example later so it's more specific and sits in order of the instructions. I had to go back/forth a few times...
content/applications/inventory_and_mrp/inventory/management/products/usage.rst
Outdated
Show resolved
Hide resolved
feku-review-add-headings-and-extra-reference Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com> Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com> Co-authored-by: Zachary Straub <zst@odoo.com> add changes
62ae133 to
91ac8bb
Compare
|
@robodoo r+ |
feku-review-add-headings-and-extra-reference add changes closes #3787 Signed-off-by: Felicia Kuan (feku) <feku@odoo.com> Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com> Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com> Co-authored-by: Zachary Straub <zst@odoo.com>


Updating images, adding more detail, rewriting to remove the second person.