[PAGES-1012] Rename norsu-template-annotations to remove norsu from name Created: 31/Jan/23  Updated: 14/Sep/23  Resolved: 16/Mar/23

Status: Resolved
Project: Magnolia pages module
Component/s: None
Affects Version/s: None
Fix Version/s: 6.3

Type: Improvement Priority: Neutral
Reporter: Christopher Zimmermann Assignee: Oanh Thai Hoang
Resolution: Fixed Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: 1.75d Time Spent: 1d
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Sub-Tasks:
Key
Summary
Type
Status
Assignee
PAGES-1013 Implementation Sub-task Completed Oanh Thai Hoang  
PAGES-1014 Review Sub-task Completed Canh Nguyen  
PAGES-1015 Pre-Integration QA Sub-task Completed Canh Nguyen  
PAGES-1016 QA Sub-task Completed Rishab Dhar  
PAGES-1070 DOC: Rename norsu-template-annotations Sub-task Closed Martin Drápela  
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)
Documentation update required:
Yes
Date of First Response:
Epic Link: SaaS Post-TPR - DevX
Sprint: DevX 33
Story Points: 2
Team: DeveloperX
Work Started:

 Description   

I'm creating this ticket based on https://jira.magnolia-cms.com/browse/NORSU-555 

If an instance is using both jcr and norsu template annotations, then they need to have different names. 

Lets use "content-template-annotations". (Reasoning in Comments.)

NOTE

PLAN the merge of this change carefully and in concert with the teams migrating Dotfusion and D&G trialists, otherwise it could break their projects.



 Comments   
Comment by Jaroslav Simak [ 27/Feb/23 ]

Ideas:

  • editor-annotations
  • content-annotations
  • annotations
  • content-template-annotations
  • cds-annotations
  • cds-template-annotations

(NOT FINAL) Decision:

  • editor-annotations for Norsu
  • jcr-editor-annotations for JCR
Comment by Christopher Zimmermann [ 06/Mar/23 ]

Lets use "content-template-annotations".

Reasoning:

It is clear to a developer that it is rellated to the existing "template-annotations".

It follows a similar pattern to the definiitons that now start with "content".

Downside is that it is long, but practicaally a developer configures it once in their project so it is not a big deal.

Also consider that we are thinking of removing this endpoint altogether and merging it into the pages endpoint response to make development simpler and reduce to just one rest caall.

Comment by Oanh Thai Hoang [ 15/Mar/23 ]

All of PRs has been merged today. Currently for preventing any breaking of other project. Both rest url will work. It mean .rest/content-template-annotations/v1/react-minimal and /.rest/norsu-template-annotations/v1/react-minimal will return the same response

 

 

https://jira.magnolia-cms.com/browse/PAGES-1079 will remove norsu-template-annotations later

Generated at Mon Feb 12 06:24:17 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.