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

refactor: rename ecoscore/eco-score fields to "environmental score" - ready for review #11117

Closed
wants to merge 16 commits into from

Conversation

stephanegigandet
Copy link
Contributor

@stephanegigandet stephanegigandet commented Dec 12, 2024

We will soon rename the Eco-Score to a new name.

To ease the transition to a new name and be more future proof, we will rename all Eco-Score internal fields to a generic "environmental score" field.

Important notes:

  • the internal attribute id "ecoscore" is not renamed, as it is stored in clients.
  • for the time being, we keep the internal facet id "ecosore" and we copy environmental_score_tags to ecoscore_tags so that MongoDB and off-query can continue to work

The name and images displayed to users will still be Eco-Score for now, but it will be changed to a new name at some point.

Plan discussed in https://docs.google.com/document/d/1LL8-aiSF482xaJ1o0AKmhXB5QWfVE0_jzvYakq3VXys/edit?tab=t.0#heading=h.pirt3xscsuwq

@stephanegigandet stephanegigandet requested a review from a team as a code owner December 12, 2024 16:39
@github-actions github-actions bot added API Issues related to the Open Food Facts API. More specific labels exist & should be used (API WRITE…) export 📦 Packaging https://wiki.openfoodfacts.org/Category:Recycling 🧴 Open Beauty Facts Our cosmetic analysis project https://world.openbeautyfacts.org Data import 🐾 Open Pet Food Facts Our pet food analysis project https://world.openpetfoodfacts.org 🧽 Data quality https://wiki.openfoodfacts.org/Quality product history We have kept 10 years of product revisions. This is useful to monitor edits & product improvements 📸 Open Products Facts Our project to increase the lifespan of objects. https://world.openproductsfacts.org 🪶 Apache We use Apache as a server to run Open Food Facts 📖 Knowledge Panels https://wiki.openfoodfacts.org/Knowledge_panels 🏭 Producers Platform https://wiki.openfoodfacts.org/Platform_for_producers 🥗🔍 Ingredients analysis https://wiki.openfoodfacts.org/Ingredients_Extraction_and_Analysis Template::Toolkit The templating toolkit used by product opener. The starting point for HTML/JS/CSS fixes. 🌱 Green-Score https://world.openfoodfacts.org/eco-score-the-environmental-impact-of-food-products 📍 Origins Origins are used for Eco-Score computation. We want to have structured origins. 🌳 Forest Footprint This is a score designed by a French NGO to assess the deforestation impact (in sq meters) Display Attributes https://wiki.openfoodfacts.org/Product_Attributes Products Tags update all products config exports Minion 🚦 Nutri-Score labels Dec 12, 2024
@github-actions github-actions bot added the 💥 Merge Conflicts 💥 Merge Conflicts label Dec 16, 2024
Copy link
Member

Choose a reason for hiding this comment

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

Name still contains Eco_score

@github-actions github-actions bot added the API READ All READ APIs include Product, Search… label Dec 17, 2024
@stephanegigandet stephanegigandet changed the title refactor: rename ecoscore/eco-score fields to "environmental score" - WIP refactor: rename ecoscore/eco-score fields to "environmental score" - ready for review Dec 17, 2024
Copy link
Member

@alexgarel alexgarel left a comment

Choose a reason for hiding this comment

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

LGTM but look at my comments above !

stephanegigandet added a commit that referenced this pull request Dec 18, 2024
…w external name and logos (#11142)

Continuation of
#11117

We will soon rename the Eco-Score to a new name.

To ease the transition to a new name and be more future proof, we will
rename all Eco-Score internal fields to a generic "environmental score"
field.

Important notes:

- the internal attribute id "ecoscore" is not renamed, as it is stored
in clients.
- for the time being, we keep the internal facet id "ecosore" and we
copy environmental_score_tags to ecoscore_tags so that MongoDB and
off-query can continue to work
- in order for attributes and knowledge panels to work before Eco-Score
has been recomputed (and new environmental_scores fields have been
created), the attributes and knowledge panels will use ecoscore_data if
environmental_data is not present.

Plan discussed in
https://docs.google.com/document/d/1LL8-aiSF482xaJ1o0AKmhXB5QWfVE0_jzvYakq3VXys/edit?tab=t.0#heading=h.pirt3xscsuwq
@stephanegigandet
Copy link
Contributor Author

Deployed through #11142 closing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🪶 Apache We use Apache as a server to run Open Food Facts API READ All READ APIs include Product, Search… API v3 API WRITE WRITE API to allow sending product info and image API Issues related to the Open Food Facts API. More specific labels exist & should be used (API WRITE…) Attributes https://wiki.openfoodfacts.org/Product_Attributes config Data import 🧽 Data quality https://wiki.openfoodfacts.org/Quality Display export exports 🌳 Forest Footprint This is a score designed by a French NGO to assess the deforestation impact (in sq meters) 🌱 Green-Score https://world.openfoodfacts.org/eco-score-the-environmental-impact-of-food-products 🥗🔍 Ingredients analysis https://wiki.openfoodfacts.org/Ingredients_Extraction_and_Analysis 🧪 integration tests 📖 Knowledge Panels https://wiki.openfoodfacts.org/Knowledge_panels 💥 Merge Conflicts 💥 Merge Conflicts Minion multilingual products 🚦 Nutri-Score 🧴 Open Beauty Facts Our cosmetic analysis project https://world.openbeautyfacts.org 🐾 Open Pet Food Facts Our pet food analysis project https://world.openpetfoodfacts.org 📸 Open Products Facts Our project to increase the lifespan of objects. https://world.openproductsfacts.org 📍 Origins Origins are used for Eco-Score computation. We want to have structured origins. 📦 Packaging https://wiki.openfoodfacts.org/Category:Recycling 🏭 Producers Platform https://wiki.openfoodfacts.org/Platform_for_producers product history We have kept 10 years of product revisions. This is useful to monitor edits & product improvements Products Tags Template::Toolkit The templating toolkit used by product opener. The starting point for HTML/JS/CSS fixes. 🧪 tests 🌐 Translations 🧪 unit tests update all products
Projects
Status: Done
Status: Done
Status: Done
Status: Done
Status: Done
Status: Done
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants