Set language attribute on resource title and descriptions #2346
Conversation
jonkafton
changed the title
There was a problem hiding this comment.
This works for now although i agree that we need to fix the etl to propagate run language data to the learning resource and also more consistently populate language data on runs. In particular i noticed MIT Professional Education has lots of foreign language courses and none of them have the language correctly set in the api on either the resource or the runs
| @@ -83,6 +83,7 @@ const ResourceDescription = ({ resource }: { resource?: LearningResource }) => { | |||
| * backend during ETL. This is safe to render. | |||
| */ | |||
| dangerouslySetInnerHTML={{ __html: resource.description || "" }} | |||
| lang={resource.runs?.[0]?.languages?.[0]} | |||
There was a problem hiding this comment.
This works. I think since generally runs are returned in a roughly chronological order getting the last run would be better since it's more likely to be a newer run so, resource.runs?.[resource.runs.length -1 ]?.languages?.[0]
OpenAPI ChangesShow/hide No detectable change.Unexpected changes? Ensure your branch is up-to-date with |
What are the relevant tickets?
Closes https://github.com/mitodl/hq/issues/6831
Description (What does it do?)
Sets a lang attribute on the learning drawer title and description and resource card titles for where available to improve machine readability.
This will provide occasional benefit, though we currently have limited data on the API:
We have a
resource.languageattribute, though I haven't come across any resources where this is not null. This course hasresource.languagenull and a title and description in Turkish: https://api.learn.mit.edu/api/v1/learning_resources/3048/.I'm using the value on
resource.runs[0].languages.[0], the first language on the fist run. This is also what we're using for the languages in the drawer info section (though listing all languages for all runs). If a course has runs in several languages, this may not be the language of the parent title and description and in any case there's not guarantee the course title and description are in the same language as the first run.Some of our data is missing or incorrect. This course offered in Spanish does not have languages set on its run: https://api.learn.mit.edu/api/v1/learning_resources/16541/. This course offered in Mandarin has "en-us" set on its run languages: https://api.learn.mit.edu/api/v1/learning_resources/2911/
The fix needed, if available on the source data, is to ensure that the language of the course title and description is always set on the on the resource so we're not selecting from the runs in hope of a match. An example of a good resource where the title matches the run language: https://api.learn.mit.edu/api/v1/learning_resources/2908/. Side note: It would be really useful to provide a language filter on the search for foreign language learners.
How can this be tested?
Search for some foreign language courses. Some searches:
Confirm that the resource list card titles have a
langattribute set to the first run language.Open the resource drawer and confirm that both the title and description have a
langattribute set.You should see similar learning resources in the same language in the drawer. Check that the resource card title links have a
langattribute set.The lang attribute should be absent if null on the first learning resource run.
Screen readers should announce the text in the relevant language voice when the element is active, though not necessarily decisive as e.g. VoiceOver on mac does auto-detects the language.