craftcms / craftcms/docs

[Content]: `Translation` class and lazy I18n

Open
#562 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
42
Forks
160
Avg merge
3h 9m
Merged PRs (30d)
4

Description

Plugin developers should have information about when to use craft\helpers\Translation::prep() and translate() over Craft::t().

Places that would be good to mention this:

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Static translations and Queue Jobs pages, then the Control Panel tour section on announcements. Document when plugin developers should use Translation::prep() and translate() instead of Craft::t(), update the relevant existing pages, and add the proposed Announcements page so plugin developers can use announcements.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.