From aefa86c05ecb4197bac9b9127027d71185b04cd9 Mon Sep 17 00:00:00 2001 From: "Lara Martini (larm)" Date: Fri, 14 Jun 2024 15:58:29 -0400 Subject: [PATCH] [ADD] Lunch: New products doc closes odoo/documentation#9901 X-original-commit: 2ae0e1598215513d4e94c9c78330103300fb6438 Signed-off-by: Lara Martini (larm) --- content/applications/hr/lunch.rst | 61 +---------------- content/applications/hr/lunch/products.rst | 62 ++++++++++++++++++ .../hr/lunch/{ => products}/category.png | Bin .../hr/lunch/{ => products}/product.png | Bin 4 files changed, 64 insertions(+), 59 deletions(-) create mode 100644 content/applications/hr/lunch/products.rst rename content/applications/hr/lunch/{ => products}/category.png (100%) rename content/applications/hr/lunch/{ => products}/product.png (100%) diff --git a/content/applications/hr/lunch.rst b/content/applications/hr/lunch.rst index 536504a81..9441cb621 100644 --- a/content/applications/hr/lunch.rst +++ b/content/applications/hr/lunch.rst @@ -217,65 +217,6 @@ Repeat this for all locations that need to be added. :align: center :alt: A list view of the locations with the new button highlighted. -Products -======== - -Before any orders can be placed, the individual products that are being offered must be configured, -as no products are pre-configured in Odoo, by default. - -First, navigate to the products page by going to :menuselection:`Lunch app --> Configuration: -Products`. Next click the :guilabel:`New` button in the top-left corner and a blank product form -loads. - -Enter the following information on the form: - -- :guilabel:`Product Name*`: enter the name for the product. -- :guilabel:`Product Category*`: using the drop-down menu, select the category this product falls - under. -- :guilabel:`Vendor*`: using the drop-down menu, select the vendor that supplies this product. -- :guilabel:`Price`: enter the price for the product. The currency is determined by the localization - of the company. -- :guilabel:`Description`: enter a description of the product in this field. This description - appears beneath the product photo when users are viewing the options for the day. -- :guilabel:`New Until`: using the calendar popover, select the date that the product will no - longer be labeled as new. Until this date, a green `New` tag appears on the product. -- :guilabel:`Company`: if the product should only be available to a specific company, select it from - the drop-down menu. If this field is left blank, this product is available for all companies in - the database. -- Image: hover over the image box in the top-right corner of the form, and click the :guilabel:`✏️ - (pencil)` edit icon that appears. A file explorer pop-up window appears. Navigate to the image, - then click :guilabel:`Open`. - - (*) indicates required field. - -.. image:: lunch/product.png - :align: center - :alt: A product form filled out for a nine inch pizza. - -Product categories -================== - -Product categories are a way to organize the offerings in the *Lunch* app, and allows for users to -quickly filter the offerings when reviewing the menu for the day. - -To add or modify categories, navigate to :menuselection:`Lunch app --> Configuration: Product -Categories`. The available categories appear in a list view. In the *Lunch* app, there are four -default categories : :guilabel:`Sandwich`, :guilabel:`Pizza`, :guilabel:`Burger`, and -:guilabel:`Drinks`. - -To add a new category, click the :guilabel:`New` button in the top-left corner, and a blank category -form loads. Enter a name in the :guilabel:`Product Category` field. If the category is -company-specific and should only appear for a certain company, select the :guilabel:`Company` from -the drop-down menu. - -If desired, add a photo for the category. Hover over the image box in the top-right, and click the -:guilabel:`✏️ (pencil)` edit icon that appears. A file explorer pop-up window appears. Navigate to -the image, then click :guilabel:`Open`. - -.. image:: lunch/category.png - :align: center - :alt: The category form, with the fields filled out for a Soup category. - Alerts ====== @@ -318,6 +259,7 @@ lunch alert form loads. Enter the following information on the form: asking employees to submit orders by 11:30 AM. .. seealso:: + - :doc:`lunch/products` - :doc:`lunch/orders` - :doc:`lunch/user-accounts` - :doc:`lunch/management` @@ -325,6 +267,7 @@ lunch alert form loads. Enter the following information on the form: .. toctree:: :titlesonly: + lunch/products lunch/orders lunch/user-accounts lunch/management diff --git a/content/applications/hr/lunch/products.rst b/content/applications/hr/lunch/products.rst new file mode 100644 index 000000000..21965c9c8 --- /dev/null +++ b/content/applications/hr/lunch/products.rst @@ -0,0 +1,62 @@ +======== +Products +======== + +Odoo's *Lunch* app does **not** come with any products preconfigured. The individual products being +offered must first be configured before orders can be placed. + +To add and configure products for the *Lunch* app, navigate to :menuselection:`Lunch app --> +Configuration --> Products`. Next, click the :guilabel:`New` button in the top-left corner, and a +blank product form loads. + +Enter the following information on the form: + +- :guilabel:`Product Name`: enter the name for the product. This field is **required**. +- :guilabel:`Product Category`: using the drop-down menu, select the :ref:`category + ` this product falls under. This field is **required**. +- :guilabel:`Vendor`: using the drop-down menu, select the vendor that supplies this product. This + field is **required**. +- :guilabel:`Price`: enter the price for the product. The currency is determined by the company's + localization. +- :guilabel:`Description`: enter a description of the product in this field. This description + appears beneath the product photo when users are viewing the day's options. +- :guilabel:`New Until`: using the calendar popover, select the date on which the product is no + longer labeled as new. Until this date, a green `New` tag appears on the product. +- :guilabel:`Company`: if the product should only be available to a specific company, select it from + the drop-down menu. If this field is left blank, this product is available for all companies in + the database. +- **Image**: hover over the image box in the top-right corner of the form, and click the + :icon:`fa-pencil` :guilabel:`(pencil)` icon that appears. A file explorer pop-up window appears. + Navigate to the image, then click :guilabel:`Open`. + +.. image:: products/product.png + :align: center + :alt: A product form filled out for a nine inch pizza. + +.. _lunch/product-categories: + +Product categories +================== + +Product categories organize the offerings in the *Lunch* app, and allows users to quickly filter +them when reviewing the menu for the day. + +To add or modify categories, navigate to :menuselection:`Lunch app --> Configuration: Product +Categories`. The available categories appear in a list view. + +In the *Lunch* app, there are four default categories: :guilabel:`Sandwich`, :guilabel:`Pizza`, +:guilabel:`Burger`, and :guilabel:`Drinks`. + +To add a new category, click the :guilabel:`New` button in the top-left corner, and a blank category +form loads. + +Enter a name in the :guilabel:`Product Category` field. If the category is company-specific and +should only appear for a certain company, select the :guilabel:`Company` from the drop-down menu. + +If desired, add a photo for the category. Hover over the image box in the top-right, and click the +:icon:`fa-pencil` :guilabel:`(pencil)` icon that appears. This opens a file explorer pop-up window. +Navigate to the image, then click :guilabel:`Open`. + +.. image:: products/category.png + :align: center + :alt: The category form, with the fields filled out for a Soup category. diff --git a/content/applications/hr/lunch/category.png b/content/applications/hr/lunch/products/category.png similarity index 100% rename from content/applications/hr/lunch/category.png rename to content/applications/hr/lunch/products/category.png diff --git a/content/applications/hr/lunch/product.png b/content/applications/hr/lunch/products/product.png similarity index 100% rename from content/applications/hr/lunch/product.png rename to content/applications/hr/lunch/products/product.png