jupyterlab/jupyterlab

Update `examples` folder to include localization.

Open

#8,828 opened on Aug 13, 2020

View on GitHub
 (6 comments) (0 reactions) (0 assignees)TypeScript (13,454 stars) (2,937 forks)batch import
good first issuemaintenancetag:Examples

Description

Task

After the localization work, the examples folder kept working as expected but the code does not make active use of localization.

In order to promote localizable code, it would be great to be able to showcase the bundled examples following the translation pattern.

Proposed Solution

Update the code in the examples folder to use an actual ITranslator (instead of the nullTranslator that is provided under the hood, and does nothing)

Additional context

Ping me for questions!

Contributor guide

Tech stack
typescript
Domain
localization
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with JupyterLab examplesUnderstanding of JupyterLab localization API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Explore the examples folder (https://github.com/jupyterlab/jupyterlab/tree/master/examples) to identify where nullTranslator is used. Review the ITranslator API documentation in JupyterLab. Look at other parts of the codebase where ITranslator is correctly implemented (e.g., in core packages) to understand the pattern. If unclear, ask the maintainer mentioned in the issue for guidance.
Update `examples` folder to include localization. · jupyterlab/jupyterlab#8828 | Good First Issue