[REF] Inventory: Restructure Inventory scope #5700

hojo-odoo · 2023-08-31T19:16:48Z

This PR restructures the entire Inventory scope, organizing all documentation within three new main categories: "Product management", "Shipping and receiving", and "Warehouses and storage". Each main category also contains multiple subcategories to further organize the documentation within.

robodoo · 2023-08-31T19:17:22Z

Pull request status dashboard.

jcs-odoo

Hi @hojo-odoo !

Cool work! I know how difficult it can be to reorganize docs and update paths everywhere ^^

⚠️Whenever you have the final structure, create the appropriate redirect rules in the /redirect/ folder at the root of this repository. This PR can't be merged without them.

As for the structure itself, I wrote a few recommendations in the files, but I would also like to give an idea, although I don't know if it would apply well in this case...

To reduce the number of levels and to make it easier to navigate, what if all the sub-categories were categories by removing the three main categories (product_management, warehouses_storage, shipping_receiving). It would mean more head-scratching to get the categories right, but that could be cool :) That's what we did for Accounting.

Another part of the restructuration could be to update some doc titles.

Good luck with this :)

cc @xpl-odoo for the doc structure team

content/applications/inventory_and_mrp/barcode.rst

content/applications/inventory_and_mrp/inventory/product_management.rst

...applications/inventory_and_mrp/inventory/shipping_receiving/advanced_operations_shipping.rst

content/applications/inventory_and_mrp/inventory/warehouses_storage.rst

hojo-odoo · 2023-09-07T21:01:43Z

Hey @jcs-odoo,

Thank you for all of your suggestions.

I would like to keep the three top-level categories. The logic behind them was to separate documentation by:

Product Management: how products are managed on an individual level.
Warehouses and Storage: how products are managed collectively and stored.
Shipping and Receiving: how products enter and leave storage.

There are a lot of Inventory documents, and I think organizing them this way makes them easier to parse through.

That being said, I agree with your suggestion about rethinking the "Advanced Operations" subcategories. I will organize those docs into more specific subcategories.

As for making updates to individual docs (changing names, updating content), I'd like to keep this PR focused on updating the structure. This is already a very complicated PR, and I'd rather not get too in the weeds by making changes to individual docs. I think that would be better to do through targeted updates, once the new structure has gone live.

Thanks,
hojo

StraubCreative · 2023-11-23T00:59:52Z

Nice work clearing the conflicts @hojo-odoo 👍
Next we'll want to update the redirects.txt file for all of the relevant RST path changes that were made in the PR.
Let's try to merge by end of next week, if possible, so conflicts don't keep piling up.
cc: @samueljlieber

samueljlieber

Hi @hojo-odoo! First I want to say awesome job with the restructuring of the inventory scope, I think you did a great job and I am looking forward to seeing this new structure moving forward!

I found a handful of items that could be improved/fixed within this pr:

Missing redirects for removed toctree files
Can remove unused images that were added
Can use :ref:s instead of :doc: links in some places to avoid going over 100 chars

Overall, all of your changes looked really great, so nice job 🙂

That being said, I will push up a second commit with all of my suggestions that you can squash/implement at your discretion.

Thank you for your continued hard work on this PR, once my suggestions are implemented I will approve this technical review.

content/applications/finance/accounting.rst

content/applications/finance/accounting/get_started/avg_price_valuation.rst

content/applications/finance/fiscal_localizations/mexico.rst

content/applications/inventory_and_mrp/inventory/management.rst

content/applications/inventory_and_mrp/inventory/management/inventory_adjustments.rst

...nventory/warehouses_storage/advanced_operations_warehouse/removal/first-expiry-first-out.png

...rp/inventory/warehouses_storage/advanced_operations_warehouse/removal/first-in-first-out.png

...p/inventory/warehouses_storage/advanced_operations_warehouse/removal/reserved-hand-cream.png

...rp/inventory/warehouses_storage/advanced_operations_warehouse/removal/reserved-lots-FIFO.png

...rp/inventory/warehouses_storage/advanced_operations_warehouse/removal/reserved-lots-LIFO.png

samueljlieber

Thank you @hojo-odoo, this PR looks good to me! @StraubCreative this is ready for final review 👍

xpl-odoo

Hello @hojo-odoo, great job! 👏

Ideally, don't use the ref markup when you should use the doc markup, and always use relative paths. See the comments inside the PR for some examples 😃

content/applications/finance/accounting.rst

content/applications/finance/accounting/get_started/avg_price_valuation.rst

content/applications/finance/expenses.rst

content/applications/finance/fiscal_localizations/egypt.rst

content/applications/finance/fiscal_localizations/mexico.rst

...cations/inventory_and_mrp/inventory/product_management/product_tracking/expiration_dates.rst

...ns/inventory_and_mrp/inventory/shipping_receiving/advanced_operations_shipping/invoicing.rst

...nventory_and_mrp/inventory/warehouses_storage/advanced_operations_warehouse/cycle_counts.rst

samueljlieber

Hi @hojo-odoo I caught just a couple more :ref: tags that need to be updated to :doc: tags, other than these 👇 everything else looks good to me! I am approving now, but please make these updates before moving forward. Thank you!

content/applications/finance/expenses.rst

...cations/inventory_and_mrp/inventory/product_management/product_tracking/expiration_dates.rst

...ns/inventory_and_mrp/inventory/shipping_receiving/advanced_operations_shipping/invoicing.rst

...ons/inventory_and_mrp/inventory/warehouses_storage/advanced_operations_warehouse/removal.rst

StraubCreative · 2023-12-07T20:08:53Z

LGTM, all checks pass 🚀

@robodoo r+

closes #5700 Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

fw-bot · 2023-12-11T05:56:44Z

@hojo-odoo @StraubCreative this pull request has forward-port PRs awaiting action (not merged or closed):

fw-bot · 2023-12-12T05:56:51Z

@hojo-odoo @StraubCreative this pull request has forward-port PRs awaiting action (not merged or closed):

[FW][REF] Inventory: Restructure Inventory scope #6878

fw-bot · 2023-12-13T05:54:53Z

@hojo-odoo @StraubCreative this pull request has forward-port PRs awaiting action (not merged or closed):

[FW][REF] Inventory: Restructure Inventory scope #6878

closes #5700 Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

closes #5700 closes #6878 Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

C3POdoo requested review from a team August 31, 2023 19:18

hojo-odoo removed request for a team August 31, 2023 19:18

jcs-odoo requested changes Sep 4, 2023

View reviewed changes

hojo-odoo force-pushed the 16.0-inventory-scope-restructure-hojo branch 2 times, most recently from 9316daa to 085c1d8 Compare November 22, 2023 22:13

hojo-odoo force-pushed the 16.0-inventory-scope-restructure-hojo branch 2 times, most recently from c84a812 to 958e238 Compare November 28, 2023 21:34

samueljlieber requested a review from a team November 29, 2023 16:27

samueljlieber requested changes Dec 4, 2023

View reviewed changes

samueljlieber approved these changes Dec 5, 2023

View reviewed changes

StraubCreative approved these changes Dec 5, 2023

View reviewed changes

StraubCreative requested review from a team and jcs-odoo December 5, 2023 21:25

xpl-odoo reviewed Dec 6, 2023

View reviewed changes

hojo-odoo force-pushed the 16.0-inventory-scope-restructure-hojo branch 2 times, most recently from 31f65bf to da64d3d Compare December 7, 2023 18:37

samueljlieber approved these changes Dec 7, 2023

View reviewed changes

[REF] Inventory: Restructure Inventory scope

1926736

hojo-odoo force-pushed the 16.0-inventory-scope-restructure-hojo branch from da64d3d to 1926736 Compare December 7, 2023 19:33

robodoo pushed a commit that referenced this pull request Dec 7, 2023

[REF] Inventory: Restructure Inventory scope

59791c2

closes #5700 Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

robodoo temporarily deployed to merge December 7, 2023 21:21 Inactive

robodoo closed this Dec 7, 2023

StraubCreative pushed a commit that referenced this pull request Dec 13, 2023

[REF] Inventory: Restructure Inventory scope

a94478a

closes #5700 Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

robodoo pushed a commit that referenced this pull request Dec 13, 2023

[REF] Inventory: Restructure Inventory scope

7fc3439

closes #5700 closes #6878 Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

StraubCreative mentioned this pull request Dec 20, 2023

[IMP] Inventory: updated for v16 #4379

Closed

This was referenced Dec 26, 2023

[FW][IMP] barcode: update transfers scratch doc #7137

Closed

[FW][IMP] barcode: update barcode operations doc #7135

Closed

samueljlieber mentioned this pull request Jul 5, 2024

[IMP] inventory: bpost customer accounts #10067

Closed

[REF] Inventory: Restructure Inventory scope #5700

[REF] Inventory: Restructure Inventory scope #5700

Uh oh!

Conversation

hojo-odoo commented Aug 31, 2023

Uh oh!

robodoo commented Aug 31, 2023

Uh oh!

jcs-odoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hojo-odoo commented Sep 7, 2023

Uh oh!

StraubCreative commented Nov 23, 2023

Uh oh!

samueljlieber left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

samueljlieber left a comment

Choose a reason for hiding this comment

Uh oh!

xpl-odoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

samueljlieber left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

StraubCreative commented Dec 7, 2023

Uh oh!

fw-bot commented Dec 11, 2023

Uh oh!

fw-bot commented Dec 12, 2023

Uh oh!

fw-bot commented Dec 13, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

samueljlieber left a comment •

edited

Loading