Difference between revisions of "Folksonomy Engine"

From Open Food Facts wiki
Jump to navigation Jump to search
(+ Workshop for contributors)
m (+ some people)
 
(22 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
The goal of '''Folksonomy engine''' is to unleash an ocean of new usages regarding food knowledge. Folksonomy engine allows all kind of people — citizens, researchers, journalists, professionals, artists, communities, innovators... — to enrich and use Open Food Facts, thanks to '''free tags and properties''' of their own, for their own use or to enrich the shared knowledge. Open Food Facts, as the biggest open-food database in the world, already feeds hundreds of data reuses. It will allow thousands of new apps and new usages.
+
The goal of '''Folksonomy engine''' is to unleash an ocean of new usages regarding food knowledge. Folksonomy engine allows all kind of people — citizens, researchers, journalists, professionals, artists, communities, innovators... — to enrich and use Open Food Facts, thanks to '''free properties''' for your own use or to enrich the shared knowledge. Open Food Facts, as the biggest open-food database in the world, already feeds hundreds of data reuses. It will allow thousands of new apps and new usages.
 +
 
 +
== Key dates and numbers ==
 +
 
 +
* 2021: project launched thanks to NlNet fund
 +
* 2021-10: Folksonomy Engine API works
 +
* 2021-11: Folksonomy Engine UI
 +
* 2022-01: First beta, for moderators only
 +
* 2024-09: Beta opened to all registered users
 +
* 2024-09: Created a tutorial
 +
 
 +
== Why it matters ==
 +
 
 +
For food products, it allows to create new kind of properties. Popular properties could join the official Open Food Facts model if they are often used.
 +
 
 +
For other products, Folksonomy Engine could be the base layer to create many different properties related to many different types of products. Eg. un smartphone have very different properties than a driller.
 +
 
 +
== What we’ve done recently ==
 +
 
 +
* 2024: Fix small bugs.
 +
* 2024-09: Opened to any registered users.
 +
* 2024-09: Created a tutorial
 +
 
 +
== What we are currently working on ==
 +
 
 +
* 2024-09: start to work on better documentation
 +
* 2024-09: creating new properties for Open Products Facts
 +
 
 +
== What’s coming up next ==
 +
 
 +
* 2024-09: new home page
 +
 
 +
== How to get involved ==
 +
 
 +
# Start to read this page.
 +
# Join #folksonomy-engine channel on Slack
 +
# Read the [[Folksonomy_Engine/Tutorial|tutorial]] to get started
 +
 
 +
== Delivered ==
 +
 
 +
# An [https://api.folksonomy.openfoodfacts.org/docs API] to allow save/retry/modify property/value pairs for each product.
 +
# A user interface to for the end user, integrated to Open Food Facts.
 +
 
 +
 
 +
== People ==
 +
 
 +
* Project owner: Charles Nepote; Lucas Huber at the beginning of the project
 +
* API dev: Christian Quest, then Alex Garel
 +
* Product Opener integration: Charles Nepote
 +
* With the help of: Stephane, Pierre, Alex, Aleene, Tacite, Jusdekiwi, Tacinte...
  
 
== Documentation and communication ==
 
== Documentation and communication ==
−
* [https://docs.google.com/document/d/1ADMs4ngCaz0qaw1HGdLCywyuAfB8cxhCfK9yQqI7dao/ Detailed presentation] (4 pages)
+
 
−
* Project document. (This current document.)
+
* [https://docs.google.com/document/d/1ADMs4ngCaz0qaw1HGdLCywyuAfB8cxhCfK9yQqI7dao/ Short presentation] (4 pages) [old documentation, to be modified]
 +
* Project document Wiki page. (This current document)
  
 
Other directories/documents (if any)
 
Other directories/documents (if any)
−
* [https://drive.google.com/drive/u/0/folders/1U7OkC6ZTg3kk_3w5mPGnb1cl5mStFqBQ Main directory for documentation]
+
* [https://drive.google.com/drive/folders/1-Dvs8hqVkHFsPqFSGl_7Pdn36hPp7WyJ?usp=drive_link Main directory for presentation, description, documentation...]
 +
 
 +
Code and bug tracking on Github:
 +
* [https://github.com/openfoodfacts/folksonomy_engine Folksonomy Engine repo]: this repository centralise issues and discussions dedicated to the whole project
 +
* [https://github.com/openfoodfacts/folksonomy_api Folksonomy Engine API repo]
 +
* [https://github.com/openfoodfacts/folksonomy_frontend Folksonomy Engine frontend repo]
 +
 
 +
 
 +
== Get in touch ==
 +
{{Box
 +
| 1    =  Slack channel
 +
| 2    =  [https://openfoodfacts.slack.com/messages/C01M1T2E8L8/ #folksonomy_engine]
 +
}}
  
−
Slack channel: [https://app.slack.com/client/T02KVRT1Q/C01M1T2E8L8/thread/C0116U37JCE-1611738330.008000 #folksonomy_engine]
+
== Use cases ==
 +
# ​ Health and food safety
 +
# ​ Cooking and preparation
 +
#  Grocery Apps
 +
#  Product qualities
 +
#  (Bad) Food Marketing
 +
## ​List properties of products targeting particular people
 +
## ​List properties of products related to consumers behavior
  
−
== Who ==
+
See, [[Folksonomy Engine/Uses cases|some use cases]] we are starting to investigate.
−
Skills needed (in short)
 
−
* Project management
 
−
* Dev
 
  
−
Project team:
+
We also have investigated separately [[Folksonomy Engine/Mobile use cases|mobile use cases]], as they allow very different kind of things.
−
* Project manager: ?
 
−
* Project owner: ?
 
−
* End-user tester: ?
 
−
* Dev: Stéphane
 
−
* Others?
 
  
 
== How ==
 
== How ==
−
Needed deliverables.
 
  
 +
As of today, Open Food Facts is made of a set of predefined properties (about 20 types of properties such as the product name, the product weight, the ingredients, the nutrients, etc.).
 +
Folksonomy engine is adding several kinds of new individual data properties to Open Food Facts or Open Products Facts. In fact, the scope of such new data properties is nearly endless, so we intend to get feedback from the community to define which one we should implement and how the user interface should look like.
 +
 +
Properties, or material facts, allows to specify a value or multiple values for the corresponding product.
 +
 +
Example: This product height is 35 cm, which ends up in a tag like [height = 35cm].
 +
 +
Sometimes a property can have multiple values:
 +
 +
Example:  This product has to be recalled if produced on 2020-03-31, 2020-04-01, 2020-04-02.
 +
[Recall: if produced from 2020-03-31 - 2020-04-02]
 +
 +
== Needs ==
 +
* More use cases to better understand how it will improve Open Food Facts
 +
* Dev contributors to improve UI
 +
 +
== Wishful deliverables ==
 +
 +
Here we put wishful deliverables, if any.
 +
* Tool to monitor tag usages.
 +
* Workshop for contributors.
 +
 +
== Questions/ideas ==
 +
* What about a deliverable dedicated to communication?
 +
* Use case in collaboration with scientists?
 +
 +
== Archives ==
 +
Old timeline.
 
{| class="wikitable"  
 
{| class="wikitable"  
 
|- style="background-color:#c0c0c0;"
 
|- style="background-color:#c0c0c0;"
Line 39: Line 127:
 
|-
 
|-
 
| D2. Functional and technical specifications (''architecture design'') (report in wiki page)
 
| D2. Functional and technical specifications (''architecture design'') (report in wiki page)
−
| Feb.
+
 
−
| XX
+
* [[Folksonomy Engine/Functional use cases and specifications|Functional use cases and specifications]].
 +
* [[Folksonomy Engine/Technical specifications|Technical specifications]].
 +
| September
 +
| Charles
 
Stéphane (Review)
 
Stéphane (Review)
 
|  
 
|  
Line 48: Line 139:
 
* CRUD interfaces in the backend (Product Opener)
 
* CRUD interfaces in the backend (Product Opener)
 
* web interfaces (in production)
 
* web interfaces (in production)
−
| April
+
| September
−
| Stéphane (dev)
+
| Christian (dev)
−
XX (tests)
+
Charles (tests)
 
|  
 
|  
 
|-
 
|-
 
| D4. Search and discovery integration and APIs.<br />Making properties accessible using simple search and a discovery engine; integration with the advanced search; API access
 
| D4. Search and discovery integration and APIs.<br />Making properties accessible using simple search and a discovery engine; integration with the advanced search; API access
 
* all dev in the backend
 
* all dev in the backend
−
| May
+
| April-May
 
| Stéphane (dev)
 
| Stéphane (dev)
 
XX (tests)
 
XX (tests)
Line 74: Line 165:
 
|}
 
|}
  
−
== Wishful deliverables ==
+
[[Category:Project]]
−
Here we put wishful deliverables if any.
+
[[Category:Folksonomy Engine]]
−
* Tool to monitor tag usages.
+
[[Category:Roadmap]]
−
* Workshop for contributors.
 
−
 
 
−
== Questions/ideas ==
 
−
* What about a deliverable dedicated to communication?
 
−
* Use case in collaboration with scientists?
 

Latest revision as of 19:42, 22 September 2024

The goal of Folksonomy engine is to unleash an ocean of new usages regarding food knowledge. Folksonomy engine allows all kind of people — citizens, researchers, journalists, professionals, artists, communities, innovators... — to enrich and use Open Food Facts, thanks to free properties for your own use or to enrich the shared knowledge. Open Food Facts, as the biggest open-food database in the world, already feeds hundreds of data reuses. It will allow thousands of new apps and new usages.

Key dates and numbers

  • 2021: project launched thanks to NlNet fund
  • 2021-10: Folksonomy Engine API works
  • 2021-11: Folksonomy Engine UI
  • 2022-01: First beta, for moderators only
  • 2024-09: Beta opened to all registered users
  • 2024-09: Created a tutorial

Why it matters

For food products, it allows to create new kind of properties. Popular properties could join the official Open Food Facts model if they are often used.

For other products, Folksonomy Engine could be the base layer to create many different properties related to many different types of products. Eg. un smartphone have very different properties than a driller.

What we’ve done recently

  • 2024: Fix small bugs.
  • 2024-09: Opened to any registered users.
  • 2024-09: Created a tutorial

What we are currently working on

  • 2024-09: start to work on better documentation
  • 2024-09: creating new properties for Open Products Facts

What’s coming up next

  • 2024-09: new home page

How to get involved

  1. Start to read this page.
  2. Join #folksonomy-engine channel on Slack
  3. Read the tutorial to get started

Delivered

  1. An API to allow save/retry/modify property/value pairs for each product.
  2. A user interface to for the end user, integrated to Open Food Facts.


People

  • Project owner: Charles Nepote; Lucas Huber at the beginning of the project
  • API dev: Christian Quest, then Alex Garel
  • Product Opener integration: Charles Nepote
  • With the help of: Stephane, Pierre, Alex, Aleene, Tacite, Jusdekiwi, Tacinte...

Documentation and communication

  • Short presentation (4 pages) [old documentation, to be modified]
  • Project document Wiki page. (This current document)

Other directories/documents (if any)

Code and bug tracking on Github:


Get in touch

Slack channel

Use cases

  1. ​ Health and food safety
  2. ​ Cooking and preparation
  3. Grocery Apps
  4. Product qualities
  5. (Bad) Food Marketing
    1. ​List properties of products targeting particular people
    2. ​List properties of products related to consumers behavior

See, some use cases we are starting to investigate.

We also have investigated separately mobile use cases, as they allow very different kind of things.

How

As of today, Open Food Facts is made of a set of predefined properties (about 20 types of properties such as the product name, the product weight, the ingredients, the nutrients, etc.). Folksonomy engine is adding several kinds of new individual data properties to Open Food Facts or Open Products Facts. In fact, the scope of such new data properties is nearly endless, so we intend to get feedback from the community to define which one we should implement and how the user interface should look like.

Properties, or material facts, allows to specify a value or multiple values for the corresponding product.

Example: This product height is 35 cm, which ends up in a tag like [height = 35cm].

Sometimes a property can have multiple values:

Example: This product has to be recalled if produced on 2020-03-31, 2020-04-01, 2020-04-02. [Recall: if produced from 2020-03-31 - 2020-04-02]

Needs

  • More use cases to better understand how it will improve Open Food Facts
  • Dev contributors to improve UI

Wishful deliverables

Here we put wishful deliverables, if any.

  • Tool to monitor tag usages.
  • Workshop for contributors.

Questions/ideas

  • What about a deliverable dedicated to communication?
  • Use case in collaboration with scientists?

Archives

Old timeline.

Deliverable Date Who Comments
D1. Ideation document: uses cases (report in wiki page)
  • define first use cases (see D6)
 Feb. XX
D2. Functional and technical specifications (architecture design) (report in wiki page) September Charles

Stéphane (Review)

D3. Server-side implementation (database and web UI): properties’ database implementation and CRUD interfaces with a minimal UI to validate the design:
  • database implementation (new database or new fields)
  • CRUD interfaces in the backend (Product Opener)
  • web interfaces (in production)
 September Christian (dev)

Charles (tests)

D4. Search and discovery integration and APIs.
Making properties accessible using simple search and a discovery engine; integration with the advanced search; API access
  • all dev in the backend
 April-May Stéphane (dev)

XX (tests)

D5. Mobile UI integration on the Open Food Facts apps June XX
D6. Three uses cases:
  1. move ambiguous “Nutriscore Experiment” labels in tags
  2. XXXX (to be found)
  3. XXXX (to be found)
 Sep. XX
Retrieved from "https://wiki.openfoodfacts.org/index.php?title=Folksonomy_Engine&oldid=24297"