Skip to content
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

docs: add tutorial for multiple products (shop shelf) #176

Merged
merged 2 commits into from
Jan 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/.pages
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
nav:
- README.md
- "Tutorial: add a price": "add-a-price"
- "Tutorial: add a price": "add-a-price"
- "Tutorial: add multiple prices": "add-multiple-prices"
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ It consists of:
- a REST API, built using FastAPI (repo: [`open-prices`](https://github.com/openfoodfacts/open-prices))
- a [web interface](https://prices.openfoodfacts.org/app/), built using Vue.js (repo: [`open-prices-frontend`](https://github.com/openfoodfacts/open-prices-frontend))

If you're a contributor, have a look at our [tutorial](add-a-price.md) to add a price!
If you're a contributor, have a look at our tutorials to add a [single](add-a-price.md) or [multiple](add-multiple-prices.md) prices!
7 changes: 5 additions & 2 deletions docs/add-a-price.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,12 @@ If the price is discounted, we currently expect the full price to be provided (i

We need a picture of the price tag that acts as a proof so that the data can be verified independently. Ideally, the image should contain both the price tag and the product. The product should be clearly visible, and the price tag should be readable.

[![Examples of good and bad proof pictures](assets/img/proof-examples.png)](assets/img/proof-examples.png)
#### Proof examples

On the first picture, the price tag and the product are visible. However, on the second picture, it's difficult to recognize the product using the photo alone.
|Good|Bad|
|---|---|
|![image](assets/img/proof-example-good.png)|![image](assets/img/proof-example-bad.png)|
|Both the price tag and the product are visible|Here it's difficult to recognize the product using the photo alone|

### Step 3: Add the location & date

Expand Down
32 changes: 32 additions & 0 deletions docs/add-multiple-prices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contribute by adding prices

## Multiple price mode (shop shelf)

This tutorial is a step-by-step guide to add multiple prices using [the web interface](https://prices.openfoodfacts.org/app/). If you have any questions, please ask us on [Slack](https://openfoodfacts.slack.com), on the #prices channel!

To add the prices, we need some information, such as a proof photo of the shelf containing the products and their corresponding prices, as well as a location (=store), etc.

Only the prices of food products are currently accepted.

### Step 1: take a photo (proof)

We need a picture of the shelf, showing the products with their price tags. This picture will be used as a proof so that the data can be verified independently. The products should be clearly visible, and the price tags should be readable.

#### Proof examples

|Good|Bad|
|---|---|
|![image](assets/img/proof-example-good-multiple.png)||
|![image](assets/img/proof-example-good-multiple-2.png)||

### Step 2: Add the location & date

The location is the store where the products are found. This can be a supermarket, a local store, a farmer's market, etc. The only requirement is that it is a physical location where you can buy food. The location needs to be registered in OpenStreetMap, otherwise you won't be able to select it. If your store is not in OpenStreetMap, you can add it there first (ask for help if you're not familiar with OpenStreetMap!).

The date is when you found the prices. It can be different from the date you actually add the prices. This is important because prices change over time, and we want to be able to track these changes.

### Step 3: Add the product prices one by one

If the products contain barcodes, you can now click on "Add a price", and start adding the product prices one by one. It's fast, as we need only 2 information per product: it's barcode, and it's price.

If it doesn't have a barcode (raw products), you should select the category among the dropdown list. Not all categories are available yet, so if you can't find the right one, please let us know. Support for other units (e.g. 1 apple) is not yet available, but will be added soon.
Binary file added docs/assets/img/proof-example-bad.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/img/proof-example-good-multiple.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/img/proof-example-good.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/img/proof-examples.png
Binary file not shown.
Loading