-
Notifications
You must be signed in to change notification settings - Fork 10.8k
[IMP] website/ecommerce: update catalog page #15569
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
base: 19.0
Are you sure you want to change the base?
Conversation
task-5136241
auva-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.
(This is only the first of two comment batches for this review! But thank you so much already for your tremendous work in this PR 🤯 🙏 !!!)
-
I think it might better (and easier) to structure the beginning of the doc a bit differently to have something that's maybe a bit closer to the options available in the Style tab. I think it would make things easier to understand, and also, for example, the search field/option also controls whether the search field is displayed at the top of the filters so it's not limited tot the "top bar". I would also rename "top bar" into "toolbar" and would maybe have something like this: (h2) Toolbar and filters (let's see if this works!) and then h3s: Categories, Filters, Toolbar. Let's maybe discuss this!
-
As discussed, let's also add a seealso for the Gelato documentation saying something like: Configure the Gelato connector in Odoo to synchronize product catalogs and automate order fulfilment with Gelato.
| To use product variants, the :guilabel:`Variants` setting **must** be activated in the Odoo *Sales* | ||
| application. | ||
|
|
||
| To do that, go to :menuselection:`Sales app --> Configuration --> Settings`, and locate the | ||
| :guilabel:`Product Catalog` section at the top of the page. | ||
|
|
||
| In that section, check the box to enable the :guilabel:`Variants` feature. |
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.
Since we're changing this part anyways, I'd suggest to improve it even further to avoid repetitions 🙈
| To use product variants, go to :menuselection:`Sales --> Configuration --> Settings`, then enable the :guilabel:`Variants` feature in the :guilabel:`Product Catalog` section at the top of the page. |
And I would even remove the screenshot right after this
| .. image:: catalog/catalog-product-block.png | ||
| :alt: Example of a catalog block for specific products |
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'd crop this screenshot so we don't see the website editor at all (it doesn't add much value, especially since it's so small AND it's going to be outdated really soon for sure)
| your e-commerce shop. You can showcase your categories, a specific product selection, or a banner | ||
| with general information or promotions. | ||
|
|
||
| Depending on the selected layout, you can customize the blocks in the :guilabel:`Style` tab. |
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.
| Depending on the selected layout, you can customize the blocks in the :guilabel:`Style` tab. | |
| Depending on the selected template, you can customize the blocks in the :guilabel:`Style` tab. |
and i'd move this after the example actually
| By default, the block displays the :guilabel:`Newest Products`. To change which products are | ||
| shown, go to the :guilabel:`Style` tab's :guilabel:`Products` section and set the | ||
| :guilabel:`Filter` field to :guilabel:`Recently Sold Products` or :guilabel:`Recently Viewed | ||
| Products (per user)`. In addition, it is possible to display products from a specific category | ||
| only using the :guilabel:`Category` field. | ||
|
|
||
| You can also filter products by :guilabel:`Tags`, :guilabel:`Show variants`, and adjust the | ||
| display by selecting a different :guilabel:`Cards Design`. |
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 think a lot of this changed actually and I would also rephrase and make sure we mention all the relevant options here (in a list form so it's easier for users to read) (add the following directly after the sentence "you can customize the blocks in the :guilabel:Style tab.")
| By default, the block displays the :guilabel:`Newest Products`. To change which products are | |
| shown, go to the :guilabel:`Style` tab's :guilabel:`Products` section and set the | |
| :guilabel:`Filter` field to :guilabel:`Recently Sold Products` or :guilabel:`Recently Viewed | |
| Products (per user)`. In addition, it is possible to display products from a specific category | |
| only using the :guilabel:`Category` field. | |
| You can also filter products by :guilabel:`Tags`, :guilabel:`Show variants`, and adjust the | |
| display by selecting a different :guilabel:`Cards Design`. | |
| For example, you can: | |
| - Adapt the block's design (add a link to this: https://www.odoo.com/documentation/19.0/applications/websites/website/web_design/building_blocks.html#edit-a-building-block) | |
| - Define which items are shown in the block by selecting the relevant :guilabel:`Filter` option. Set the field to :guilabel:`Category list` to show product categories. (add link to relevant section/doc) | |
| - Select a specific product category in the :guilabel:`Filters` dropdown list. | |
| - Toggle the :guilabel:`Clickable items` switch on to make the product/category cards clickable or toggle it off to display a button on the cards, then define the :guilabel:`Button`'s label. (this can probably be improved) |
| Footer block | ||
| ~~~~~~~~~~~~ | ||
|
|
||
| There is a :guilabel:`eCommerce` footer block that features all the available payment methods in the | ||
| footer. | ||
| Click the footer and select the :guilabel:`eCommerce` template in the :guilabel:`Template` field. | ||
| Click the payment method section, and choose a :guilabel:`Limit` and the :guilabel:`Height` in the | ||
| :guilabel:`Supported Payment Methods` section. | ||
|
|
||
| .. note:: | ||
| It is not possible to create a customized footer per category. |
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 think we should change the header since it's not a block, and also add links to the relevant docs
| Footer block | |
| ~~~~~~~~~~~~ | |
| There is a :guilabel:`eCommerce` footer block that features all the available payment methods in the | |
| footer. | |
| Click the footer and select the :guilabel:`eCommerce` template in the :guilabel:`Template` field. | |
| Click the payment method section, and choose a :guilabel:`Limit` and the :guilabel:`Height` in the | |
| :guilabel:`Supported Payment Methods` section. | |
| .. note:: | |
| It is not possible to create a customized footer per category. | |
| Ecommerce-specific website footer | |
| ~~~~~~~~~~~~ | |
| The :ref:`website footer <add link to this: https://www.odoo.com/documentation/master/applications/websites/website/structure/header_footer.html#footer-design> | |
| can also be configured to use the ecommerce-specific template. Select the template, then add the | |
| relevant :ref:`links <add link to this: https://www.odoo.com/documentation/19.0/applications/websites/website/web_design/elements.html#links>` | |
| and adapt the footer's text and layout as needed in the website editor. The :doc:`available payment | |
| methods <add link to this: https://www.odoo.com/documentation/master/applications/finance/payment_providers.html>` | |
| are also shown in this footer. To adapt their display, go to the :guilabel:`Supported Payment | |
| Methods` section in the website editor. |
| .. seealso:: | ||
| - :doc:`Products <../products>` | ||
| - :doc:`additional_features` | ||
| Catalog blocks |
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 think I would add a h2 before this heading describing the purpose
For example: Catalog quick access from other website pages
or something similar?
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.
EDIT: sorry it seems I have posted the same comment twice and I can no longer delete my own comments (thank you GitHub ...), I can only edit it. Please ignore this one!
auva-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.
Hello @lman-odoo, here's the second (and last) part of this first review. Thank you for your patience! As usual, feel free to reach out if anything's unclear or if you'd like to discuss any of my comments/questions!
(PS: Don't forget to avoid you/your when possible (e.g., your website, your products, etc.))
| Odoo's product configurator offers many possibilities to define product variants or to organize | ||
| products by category. |
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 wouldn't use the term "product configurator" I think or I would at least explain what we mean by that. I would also rephrase this intro to focus on eCommerce and how variant and organizing products by category impact the ecommerce (catalog), very briefly.
| :doc:`Product variants </applications/sales/sales/products_prices/products/variants>` are different | ||
| versions of the same product, such as those with varying colors or materials, which may have | ||
| potential differences in price and availability. |
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.
| :doc:`Product variants </applications/sales/sales/products_prices/products/variants>` are different | |
| versions of the same product, such as those with varying colors or materials, which may have | |
| potential differences in price and availability. | |
| :doc:`Product variants </applications/sales/sales/products_prices/products/variants>` are different versions of the same product, created by combining :ref:`attributes <add ref>` like color, size, material, etc., which can lead to differences in price and/or availability. |
I think mentioning attributes here rather than mentioning variants under Attributes makes more sense
| ---------- | ||
|
|
||
| Attributes refer to the characteristics of a product, such as its color or material, whereas | ||
| variants are the different combinations of attributes. Each attribute includes a set of values. |
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.
| variants are the different combinations of attributes. Each attribute includes a set of values. | |
| Attributes refer to the characteristics of a product, such as its color or material. Each attribute includes a set of values. |
(since we explained variants above, I don't think we need to mention them here)
| .. image:: catalog/catalog-attributes.png | ||
| :alt: Attributes and variants of your product |
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 think I would change this screenshot to show several attributes and values
| #. Access the :ref:`product form <ecommerce/products/product-form>`, and go to the | ||
| :guilabel:`Attributes & Variants` tab, where you can add attributes and values, enabling | ||
| customers to configure and select product variants on the product page. You can combine multiple | ||
| attributes to create specific variants. |
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'd add a seperate step for the attributes' configuration:
| #. Access the :ref:`product form <ecommerce/products/product-form>`, and go to the | |
| :guilabel:`Attributes & Variants` tab, where you can add attributes and values, enabling | |
| customers to configure and select product variants on the product page. You can combine multiple | |
| attributes to create specific variants. | |
| #. Access the :ref:`product form <ecommerce/products/product-form>`, and go to the | |
| :guilabel:`Attributes & Variants` tab. | |
| #. Click :guilabel:`Add a line` and select the relevant attribute and its values. Repeat this step for each additional attribute. | |
| The product variants are created automatically (or not) based on the :ref:`attribute's configuration <add ref to sales doc where we talk about attributes and the variant creation field>`. | |
| .. seealso:: | |
| (add link to sales doc on variants) |
| In the optional :guilabel:`eCommerce Category` field of the attribute form, select a category from | ||
| a drop-down menu to group similar attributes under the same section for added specificity and | ||
| organization, when :ref:`comparing products | ||
| <ecommerce/products/additional_features/product-comparison>`. |
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 think we can simplify this, and start with the purpose of attribute categories:
| In the optional :guilabel:`eCommerce Category` field of the attribute form, select a category from | |
| a drop-down menu to group similar attributes under the same section for added specificity and | |
| organization, when :ref:`comparing products | |
| <ecommerce/products/additional_features/product-comparison>`. | |
| To group similar attributes under the same section when :ref:`comparing products | |
| <ecommerce/products/additional_features/product-comparison>`, select the relevant :guilabel:`eCommerce Category` or create a new one. |
|
|
||
| Clicking :guilabel:`Create` creates the category, which can be modified later. Clicking | ||
| :guilabel:`Create and edit...` creates the category and display a :guilabel:`Create eCommerce | ||
| Category` pop-up window, in which the new attribute category can be configured and customized. |
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'd simplify and rephrase to focus on what users can do (instead of describing the form and then explaining a little bit what they can do, if that makes sense). I would also use a bullet list to do so to avoid repetitions and improve readibility:
| Category` pop-up window, in which the new attribute category can be configured and customized. | |
| - Rename the category. | |
| - Change its :guilabel:`Sequence`. | |
| - Reorder the :guilabel:`Related Attributes` --> here I would clarify the impact of the attributes' order in this list, I'm not sure I get it | |
| - Add attributes to the category by clicking :guilabel:`Add a line`. |
(I also suggested to remove the parts about create/create and edit as it's standard odoo behavior)
|
|
||
| .. note:: | ||
| - A single product can belong to multiple eCommerce categories. | ||
| - Define how to :doc:`display categories <catalog>` on the shop page. |
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'd change the doc link to a ref once you've changed the structure of the catalog doc page
|
|
||
| eCommerce categories are used to organize products into groups, making it easier for customers | ||
| to browse the online store. | ||
|
|
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 think it might be useful here to add a screenshot to show what we're talking about exactly? (especially since they're using the word "categories" for a few different things ...)

task-5136241