[MGNLREST-292] DOC: Ensure devs know about referenceResolvers Created: 01/Dec/20  Updated: 28/Mar/22

Status: Open
Project: Magnolia REST Framework
Component/s: None
Affects Version/s: None
Fix Version/s: None

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

Attachments: PNG File image-2020-12-01-12-37-24-785.png     PNG File image-2020-12-01-13-01-18-618.png    
Issue Links:
relation
is related to DOCU-2069 Ensure devs know about referenceResol... 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)
Date of First Response:

 Description   

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

This page should mention referenceResolving earlier and provide an overview of what it is for.

https://documentation.magnolia-cms.com/display/DOCS62/Delivery+endpoint+API+v2#DeliveryendpointAPIv2-Configuration

 

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



 Comments   
Comment by Christopher Zimmermann [ 01/Dec/20 ]

Yes the documentation is present, but I think it should be more visible in the typical path a develoer will read. I think we can solve this with a small change.

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