[MGNLFE-29] Rename 'RenderContext' to 'EditorContext' Created: 17/Mar/20  Updated: 20/Apr/20  Resolved: 09/Apr/20

Status: Closed
Project: Magnolia Frontend Helpers
Component/s: None
Affects Version/s: None
Fix Version/s: 1.0.1

Type: Improvement Priority: Neutral
Reporter: Christopher Zimmermann Assignee: Canh Nguyen
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: 0d
Time Spent: 1d 3.5h
Original Estimate: Not Specified

Issue Links:
causality
caused by MGNLFE-18 Rename libs from @magnolia/react-rend... Closed
dependency
is depended upon by MGNLFE-24 DOC: Components and libraries renamed Closed
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Release notes required:
Yes
Documentation update required:
Yes
Epic Link: SPA Editor
Sprint: 6.2.1 Ramp-up 21
Story Points: 2

 Description   

Rename RenderContext to EditorContext in both libraries. 

Rationale:

In a previous ticket (MGNLFE-18) we renamed the packages from 'react-renderer' and 'angular-renderer' to 'react-editor' and 'angular-editor'. 

However the Contexts are still named 'RendererContext', this terminology is confusing when used in a project because a developer does not know what 'Renderer' is referring to. (Generally React or Angular themselves are thought of as the renderer.)

AC: Implement deprecation

We must be able to evolve and deprecate early APIs and namings gradually, then we can do 1.0.1s or 1.1.0s.
—regardless of whether it's at the cost of duplicate component classes, or if we find deprecation utils, compatibility code generation, etc. I expect more changes will surface in time, so we'll have to go down that road anyway.

With proper deprecation messages, change logs, early adopters will adjust pretty fast.


Generated at Mon Feb 12 05:43:32 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.