translatable-xblocks 1.0.0

Plugin for adding translation behavior to XBlocks

translatable-xblocks

Purpose

Plugin for adding translation behavior to XBlocks. This plugin assumes:

1. Translations IDA is setup (https://github.com/edx/ai-translations).

2. Frontend plugin setup to add translation selector.

When present and enabled, requesting a src_lang and dest_lang as query params in a unit render should request and return translated versions of those XBlocks’ content.

WARNING: This replaces some native XBlocks from edx-platform and replaces them with custom versions. While we only override small portions of functionality, there is a chance this will cause things to “spookily” break. See translatable_xblocks/apps.py for where we do this block replacement.

Guides

• Quickstart.

• How to test this repository.

• How to deploy this repository.

Getting Started with Development

See quickstart guide.

Conventions / Rules / Best Practices

1. Use conventional commits for making commits.

2. Format files with black. Do this and other fixes automatically with make format.

3. Squash commits when merging a PR.

Please see also the Open edX documentation for guidance on Python development in this repo.

Testing

See how to test this repository.

Deploying

See how to deploy this repository.

Getting Help

Documentation

PLACEHOLDER: Start by going through the documentation. If you need more help see below.

(TODO: Set up documentation)

More Help

If you’re having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.

Our real-time conversations are on Slack. You can request a Slack invitation, then join our community Slack workspace.

For anything non-trivial, the best path is to open an issue in this repository with as many details about the issue you are facing as you can provide.

https://github.com/edx/translatable-xblocks/issues

For more information about these options, see the Getting Help page.

License

The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.

Please see LICENSE.txt for details.

Contributing

Contributions are very welcome. Please read How To Contribute for details.

This project is currently accepting all types of contributions, bug fixes, security fixes, maintenance work, or new features. However, please make sure to have a discussion about your new feature idea with the maintainers prior to beginning development to maximize the chances of your change being accepted. You can start a conversation by creating a new issue on this repo summarizing your idea.

The Open edX Code of Conduct

All community members are expected to follow the Open edX Code of Conduct.

People

The assigned maintainers for this component and other project details may be found in Backstage. Backstage pulls this data from the catalog-info.yaml file in this repo.

Reporting Security Issues

Please do not report security issues in public. Please email [e-mail].

Change Log

Unreleased

0.1.0 – 2024-03-06

Added

• First release on PyPI.