feat: Add short name, value and evaluation to knowledge panels #9683
Conversation
github-actions
bot
added
📚 Documentation
|
Hi @stephanegigandet . Creating a draft pull request so you can review the proposed changes to the knowledge panel schema |
| @@ -13,6 +13,20 @@ properties: | |||
| expand_for: | |||
| type: string | |||
| description: 'If set to "large", the content of the panel should be expanded on large screens, but it should still be possible to unexpand it.' | |||
| name: | |||
There was a problem hiding this comment.
for name and description, I think it would fit best in the title element where we already have a title / sub_title:
https://github.com/openfoodfacts/openfoodfacts-server/blob/main/docs/api/ref/schemas/knowledge_panels/elements/title_element.yaml
Currently we have:
title_element: {
icon_size: "small",
title_element: {
icon_size: "small",
icon_url: "https://static.openfoodfacts.org/images/misc/high.svg",
title: "Saturated fat in high quantity (10.6%)"
},icon_url: "https://static.openfoodfacts.org/images/misc/high.svg",
title: "Saturated fat in high quantity (10.6%)"
},
We could add "name", "value" in there, as they would be displayed as the clickable knowledge panel title.
We could also add "value_label" or similar so that we can display the "Additives to avoid" in the mockup:
There was a problem hiding this comment.
Aren't the "Additives to avoid" just names too? e.g. we could equally well display it as:
Additives to avoid >
(red circle) 0
There was a problem hiding this comment.
Indeed, in terms of data, both the Fat and Additive to avoid panels are the same. There's a "field" name (fat or additive to avoid) and a value, possibly a unit (%), and an evaluation. So no need for "value_label"
github-actions
bot
added
🧪 tests
Food.pm
Template::Toolkit
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #9683 +/- ##
===========================================
- Coverage 49.44% 39.18% -10.27%
===========================================
Files 67 63 -4
Lines 20644 20164 -480
Branches 4978 4882 -96
===========================================
- Hits 10208 7901 -2307
- Misses 9139 11130 +1991
+ Partials 1297 1133 -164 ☔ View full report in Codecov by Sentry. |
github-actions
bot
added
API
|
|
@john-gom @stephanegigandet any blockers to merging? cc @g123k |
teolemon
added
🎯 P0
🤳🥫 blocking mobile apps
|
@john-gom @stephanegigandet what's the command to update test results ? That might solve the conflict |
|
@g123k FYI, the PR for the square knowledge panel is actually there |
|
I'm adding a property "half_width_on_mobile": true, for nutrient levels, and updating the tests. |
There was a problem hiding this comment.
Cool to have updated the documentation here !
|
/update_tests_results |
|
🤖 I have created a release *beep* *boop* --- ## [2.45.0](v2.44.0...v2.45.0) (2024-10-02) ### Features * Add short name, value and evaluation to knowledge panels ([#9683](#9683)) ([bb5c3e2](bb5c3e2)) * enable attributes / personal search on OBF, OPF, OPFF, new config + logos for OPF & OPFF ([#10757](#10757)) ([7e25d9a](7e25d9a)) * make improvements to org table ([#10679](#10679)) ([b0cfea1](b0cfea1)) * Small fixes + improvements ([#10818](#10818)) ([bd91419](bd91419)) ### Bug Fixes * add Moji server IP to rate-limit allow-list ([#10785](#10785)) ([065e0ab](065e0ab)) * add more nutrients to test, to test more things ([#10834](#10834)) ([42b341d](42b341d)) * also check .pot GetText files in addition to .po files ([#10827](#10827)) ([bb87197](bb87197)) * Determine obsolete and deleted from the product revision ([#10791](#10791)) ([508d767](508d767)) * do not localize ecoscore on obf,opf,opff ([#10837](#10837)) ([2f93877](2f93877)) * docs Adding closing ) to generate proper internal link ([#10850](#10850)) ([492d6d9](492d6d9)) * docs Fixed proper denomination of product in query ([#10853](#10853)) ([428dbb3](428dbb3)) * improve OCR JSON generation script ([#10802](#10802)) ([3e8fee7](3e8fee7)) * incorrect self-reference in ingredient.yaml ([#10786](#10786)) ([2757699](2757699)) * indicate some attributes have only mandatory / not_important options ([#10846](#10846)) ([258dc8f](258dc8f)) * invalid type in product_misc.yaml ([#10787](#10787)) ([21920a1](21920a1)) * new mongodb exports for obsolete products collection ([#10794](#10794)) ([c22fc42](c22fc42)) * permissions for check-translations.sh ([#10838](#10838)) ([62e12d6](62e12d6)) * YAML syntax in schema files. ([#10783](#10783)) ([959c74c](959c74c)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
What
Create simple, short details for each panel to allow more compact visualisation, e.g. he new two-column approach in the mobile app.
Related issue(s) and discussion