Uploaded image for project: 'Magnolia Frontend Helpers'
  1. Magnolia Frontend Helpers
  2. MGNLFE-29

Rename 'RenderContext' to 'EditorContext'

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Done
    • Neutral
    • 1.0.1
    • None
    • None
    • None
    • Yes
    • Yes
    • 6.2.1 Ramp-up 21
    • 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.

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                canh.nguyen Canh Nguyen
                czimmermann Christopher Zimmermann
                Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Task DoD

                    Time Tracking

                      Estimated:
                      Original Estimate - Not Specified
                      Not Specified
                      Remaining:
                      Remaining Estimate - 0d
                      0d
                      Logged:
                      Time Spent - 1d 3.5h
                      1d 3.5h