Skip to content

Conversation

@StraubCreative
Copy link
Contributor

@StraubCreative StraubCreative commented Aug 3, 2022

Overview

This is a batch cherry pick of PR’s #2002, #1984, #1900, #1876, #1870, #1854, and #1824
I took the changes originally proposed in these PR’s and stacked them here on a fresh 15.0 base since they were all merge requests into 15.0.

Formatting updates

On top of the original changes proposed by @thomasdeleval, I went ahead and updated technicals for each affected RST file + associated images. Those changes are as follows in order to bring each doc up to standards:

  • fixed 100th character line breaks
  • added alt text to images with proper grammar
  • fixed indentations on RST tags
  • renamed images attached to respective RST files (when appropriate) to match new convention (usage_01.png —> uom-handling-vs-purchase.png), and updated RST links accordingly.
  • fixed some broken links + misnamed folders

Follow up items for review

I did not change any of the content other than what what the PRs originally suggested, however I think there are a number of improvements to be made around wording, grammar, and specificity of language.

Generally speaking, please consider the following suggestions in content review stage:

  • add missing :guilabel:'s 😈
  • wording/grammar: I caught a number of instances where the technical details were too wordy, vague, or the instruction got lost / wasn’t clear. Some words are strange like “hit” instead of “click” or “choose”.
  • headings: especially the h1 so they follow convention re:guidelines:headings
  • Consider rephrasing all hypothetical narratives (e.g. “imagine if…”). Would stick to third-person instructional w/ time order language, if possible. “What if” scenarios are more helpful when visually illustrated with video or long-form blog articles, however for software documentation, this will interrupt ability to skim and absorb instructions which are supposed to be clear and easy to find.
  • Similarly, would also reword/remove all first-person and second-person familiar statements and stick with third-person instructional.
  • images: check all for HD resolution, at or around 768 pixel breakpoint in width, and are compressed. Are there any images that need to be reshot?
  • images: are they actually showcasing the feature being written about? Some aren’t clear.
  • remove unnecessary images, or surround them with new blocks of descriptive copy so the writing is leading the document instead of the visuals re: guidlines:images

@StraubCreative StraubCreative marked this pull request as draft August 3, 2022 00:21
@StraubCreative StraubCreative self-assigned this Aug 3, 2022
@robodoo
Copy link
Collaborator

robodoo commented Aug 3, 2022

@StraubCreative StraubCreative force-pushed the 15.0-inventory-thd-batch-updates-zst branch 3 times, most recently from db2e5f2 to f3d1959 Compare August 4, 2022 23:57
Copy link
Contributor

@mivu-odoo mivu-odoo left a comment

Choose a reason for hiding this comment

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

Finished reviewing content in wave_transfers.rst, will need to come back another time to review content in the other changed RST files.

For wave_transfers.rst, I fixed the wording to remove use of familiar second-person "you", added transition words and phrases to improve readability, fixed spelling and grammar issues, took new screenshots because the current images are wider than tablet breakpoint size, and left comments for which images can be removed.

@StraubCreative StraubCreative force-pushed the 15.0-inventory-thd-batch-updates-zst branch from f3d1959 to 3b37ae8 Compare August 5, 2022 00:21
@StraubCreative StraubCreative marked this pull request as ready for review August 5, 2022 00:26
@C3POdoo C3POdoo requested a review from a team August 5, 2022 00:27
Copy link
Contributor

@mivu-odoo mivu-odoo left a comment

Choose a reason for hiding this comment

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

Finished review for count_products.rst

Lots of images were too wide, so I took new screenshots and linked them in my comments. I also think some images aren't necessary and should be deleted, because they are redundant or they show very simple and basic things that are easy to find.

I also fixed wording. There were some spelling errors and some sentences did not make sense. I also added transition words to help the flow of the doc and show chronological order.

Copy link
Contributor

@mivu-odoo mivu-odoo left a comment

Choose a reason for hiding this comment

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

Finished review on cycle_counts.rst

A short and sweet one. Rewrote some sentences for better flow and clarity. Replaced one image inventory-frequency.png that was way too wide.

Copy link
Contributor

@mivu-odoo mivu-odoo left a comment

Choose a reason for hiding this comment

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

Finished review of strategies.rst

This was a hefty one with a lot of spelling errors.

Copy link
Contributor

@mivu-odoo mivu-odoo left a comment

Choose a reason for hiding this comment

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

Finished reviewing uom.rst

I found a lot of images were not needed b/c they were redundant and showed very obvious things that should be clear from the text. Other than that, I also fixed headers to be in sentence case and removed uses of familiar second-person pronouns like you, your, etc.

Copy link
Contributor

@mivu-odoo mivu-odoo left a comment

Choose a reason for hiding this comment

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

Fixed wording, formatting, and grammar issues. Some images for units of measure aren't needed. It's overkill when we could just link to the uom.rst in a See Also section at the end.

Copy link
Contributor

@mivu-odoo mivu-odoo left a comment

Choose a reason for hiding this comment

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

Finished reviewing integrating_landed_costs.rst, had to remove uses of second-person pronouns and rewrite sections for better flow. One question for @thomasdeleval on where to view the landed cost accounting journal entry: #2556 (comment). The sentence is unclear.

Copy link
Contributor

@mivu-odoo mivu-odoo left a comment

Choose a reason for hiding this comment

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

Finished reviewing resupply_warehouses.rst. Had to rewrite some sections for better flow and to remove uses of first and second-person pronouns.

@StraubCreative StraubCreative force-pushed the 15.0-inventory-thd-batch-updates-zst branch from 3b37ae8 to 095a938 Compare October 18, 2022 20:11
@StraubCreative
Copy link
Contributor Author

Hi @mivu-odoo

Latest changes on 095a938, content revisions for:

  • cycle_counts.rst
  • count_products.rst
  • wave-transfers.rst

Also rebased to latest commit e21dbd0 and solved merge conflict for putaway.rst. Luckily there was only the one :)

At this point, @samueljlieber is going to jump in and help implement the next batch of content changes.


@samueljlieber, I already cleaned up the RST, and @mivu-odoo did a strong pass on most of the content. What's needed now is to implement what MIVU change requests so far, however, we still have a couple docs left to review. Also if you catch anything I missed feel free to fix as well ;)

You can get started here at this comment, and then work your way down, through each file, as far as you can.

When complete, please notify us here on progress, ty! 🙏


@everyone if/once the feature branch is on your computer, friendly reminder to do git pull --rebase each time before you work on it to ensure you're pulling in the latest content!

@samueljlieber samueljlieber force-pushed the 15.0-inventory-thd-batch-updates-zst branch from 0ef803e to f7c003b Compare October 24, 2022 15:53
@samueljlieber
Copy link
Contributor

@AntoineVDV Thank you for the suggestions! They have been implemented in f7c003b.

Copy link
Collaborator

@AntoineVDV AntoineVDV left a comment

Choose a reason for hiding this comment

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

robodoo pushed a commit that referenced this pull request Oct 25, 2022
closes #2556

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
@robodoo robodoo temporarily deployed to merge October 25, 2022 14:23 Inactive
@robodoo robodoo closed this Oct 25, 2022
@StraubCreative StraubCreative mentioned this pull request Jan 4, 2023
jcs-odoo added a commit to odoo-dev/odoo that referenced this pull request Apr 26, 2023
This commit updates the documentation URLs to the current URLs, although
there are already redirect rules in place as fallback.

Related odoo/documentation pull requests:

Calendar:
odoo/documentation#4032
task-3217827

POS
odoo/documentation#4226
task-3284514

Inventory
odoo/documentation#2556
robodoo pushed a commit to odoo/odoo that referenced this pull request Apr 28, 2023
This commit updates the documentation URLs to the current URLs, although
there are already redirect rules in place as fallback.

Related odoo/documentation pull requests:

Calendar:
odoo/documentation#4032
task-3217827

POS
odoo/documentation#4226
task-3284514

Inventory
odoo/documentation#2556

closes #119824

Related: odoo/enterprise#40372
Signed-off-by: Raphael Collet <rco@odoo.com>
jcs-odoo added a commit to odoo-dev/odoo that referenced this pull request May 2, 2023
This commit updates the documentation URLs to the current URLs, although
there are already redirect rules in place as fallback.

Related odoo/documentation pull requests:

Calendar:
odoo/documentation#4032
task-3217827

POS
odoo/documentation#4226
task-3284514

Inventory
odoo/documentation#2556
robodoo pushed a commit to odoo/odoo that referenced this pull request May 2, 2023
This commit updates the documentation URLs to the current URLs, although
there are already redirect rules in place as fallback.

Related odoo/documentation pull requests:

Calendar:
odoo/documentation#4032
task-3217827

POS
odoo/documentation#4226
task-3284514

Inventory
odoo/documentation#2556

closes #120149

Related: odoo/enterprise#40548
Signed-off-by: Raphael Collet <rco@odoo.com>
jcs-odoo added a commit to odoo-dev/odoo that referenced this pull request May 2, 2023
This commit updates the documentation URLs to the current URLs, although
there are already redirect rules in place as fallback.

Related odoo/documentation pull requests:

Calendar:
odoo/documentation#4032
task-3217827

POS
odoo/documentation#4226
task-3284514

Inventory
odoo/documentation#2556
robodoo pushed a commit to odoo/odoo that referenced this pull request May 2, 2023
This commit updates the documentation URLs to the current URLs, although
there are already redirect rules in place as fallback.

Related odoo/documentation pull requests:

Calendar:
odoo/documentation#4032
task-3217827

POS
odoo/documentation#4226
task-3284514

Inventory
odoo/documentation#2556

closes #120300

Related: odoo/enterprise#40600
Signed-off-by: Raphael Collet <rco@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
jcs-odoo added a commit to odoo-dev/odoo that referenced this pull request May 2, 2023
This commit updates the documentation URLs to the current URLs, although
there are already redirect rules in place as fallback.

Related odoo/documentation pull requests:

Calendar:
odoo/documentation#4032
task-3217827

POS
odoo/documentation#4226
task-3284514

Inventory
odoo/documentation#2556
robodoo pushed a commit to odoo/odoo that referenced this pull request May 3, 2023
This commit updates the documentation URLs to the current URLs, although
there are already redirect rules in place as fallback.

Related odoo/documentation pull requests:

Calendar:
odoo/documentation#4032
task-3217827

POS
odoo/documentation#4226
task-3284514

Inventory
odoo/documentation#2556

closes #120345

Related: odoo/enterprise#40623
Signed-off-by: Raphael Collet <rco@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants