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

adding glossary to design system #134

Merged
merged 7 commits into from
Dec 1, 2020

Conversation

indirectlylit
Copy link
Contributor

Adds glossary based on Crowdin tbx file to design system

image

@radinamatic
Copy link
Member

Thank you for pushing on this!

I'll have to go back and check my notes from a few years ago, before we made a first glossary, I remember for some reason not being happiest with the TBX.

@indirectlylit
Copy link
Contributor Author

I believe TBX is the only format Crowdin offers downloads in

https://support.crowdin.com/api/download-glossary/

@radinamatic
Copy link
Member

No, it offers download and upload as CSV & XLSX too, and we've been using the latter as it allows for easier import and share as a GDoc for translation.

Selection_100

@nucleogenesis
Copy link
Member

@indirectlylit

I think that the table's two left-most columns look squished. This may be a more of a critique of the design system layout itself though - perhaps a max-width of 900 or so might look better (the grid layout of the columns could then be adjusted so at least the left-most column has more breathing room).

I'd be curious to see how that might affect other parts of the app's appearance though. It's not a big deal honestly just looked off to me a bit.


A couple thoughts:

  • I wonder if it would be easy to add a filtering search bar like we have for the icons
  • How often will we need to update the glossary? Will we just - when needed - download the latest glossary? I wonder if we could securely load the XML dynamically (server side?) and just always use the latest TBX file that way.

@indirectlylit
Copy link
Contributor Author

No, it offers download and upload as CSV & XLSX

Okay - hopefully the API supports it also. I had these functions written for import/export, but it could also be done as a manual UI process

https://github.com/learningequality/kolibri/blob/68f33c3f429f55c60af23d6752ba389a6ac20a0d/build_tools/i18n/crowdin.py#L451-L477

I wonder if it would be easy to add a filtering search bar like we have for the icons

quite easy

How often will we need to update the glossary?

When we first created it, we discussed updating it once per translation push on Kolibri (once per major release)

@indirectlylit
Copy link
Contributor Author

@nucleogenesis added filter and widened overall table and left column:

2020-12-01 11 29 17

@indirectlylit
Copy link
Contributor Author

@radinamatic @nucleogenesis we should decide what the process for managing the glossary "source of truth" should be.

See the discussion in this PR to refresh your memory about work and stop-gap decisions made previously:

learningequality/kolibri#6019

Copy link
Member

@nucleogenesis nucleogenesis left a comment

Choose a reason for hiding this comment

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

LGTM!

@nucleogenesis
Copy link
Member

we should decide what the process for managing the glossary "source of truth" should be.

@indirectlylit @radinamatic this PR looks good to me - but I think we should merge this and discuss that process in a quick meeting or on Slack.

@nucleogenesis nucleogenesis merged commit 00dc8a0 into learningequality:v0.2.x Dec 1, 2020
@indirectlylit indirectlylit deleted the glossary branch December 2, 2020 02:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants