[DOCU-2069] Ensure devs know about referenceResolvers and how they work in headless docs Created: 01/Dec/20  Updated: 01/Dec/20  Resolved: 01/Dec/20

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: High
Reporter: Christopher Zimmermann Assignee: Christopher Zimmermann
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
relation
is related to MGNLREST-292 DOC: Ensure devs know about reference... Open

 Description   

Reference resolvers are non-intuitive and can cause developer confusion and wasted time if they are not known about and well understood.

They should be documented on this page: https://hd.magnolia-cms.com/docs/api/delivery

It should link to this detailed page on Reference Resolving: https://documentation.magnolia-cms.com/display/DOCS62/Resolving+references+with+the+delivery+endpoint

 

See related "SUGGEST" ticket: https://jira.magnolia-cms.com/browse/SUGGEST-246



 Comments   
Comment by Eric Hechinger [ 01/Dec/20 ]

Hello czimmermann
Quick mention from my side (just to ensure that we are on the same page). 
As you mentioned and also highlighted by Martin (MGNLREST-292), the content is available in the product documentation. You can refer to or reuse it as much as you want, but it is out of the scope of the documentation team's duty to maintain & update the content of the headless documentationhttps://hd.magnolia-cms.com). 
Hope we are on the same page. 

Do not hesitate to contact me directly in case of concerns or doubt. 
Thanks 

Comment by Christopher Zimmermann [ 01/Dec/20 ]

Agreed. 

I created 2 tickets. This ticket for the hd.magnolia-cms.com,  I assigned to myself.

The other ticket in the normal docs and for the docs team: MGNLREST-292

Comment by Christopher Zimmermann [ 01/Dec/20 ]

Updated: https://hd.magnolia-cms.com/docs/api/delivery

Generated at Mon Feb 12 01:23:46 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.