[DOCU-1806] A note in REST docs about defining fallback themes for sites Created: 13/Dec/18  Updated: 28/May/20  Resolved: 28/May/20

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: 5.6, 5.7, 6.1, 6.2
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Martin Drápela Assignee: Ashraf Khamis
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
causality
caused by MGNLREST-194 Endpoint returns default rendition fo... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: Pre-2019 mgnl-staff requests
Sprint: Docu Sprint 79
Story Points: 2

 Description   

From slack docu room, 13 December 2018:

Viet Nguyen [5:11 AM]
@here we had a docs update request from proximus.com below, I'll try to describe it as 'clear' as possible and probably @mika could fix this by enhancing our fallback site definition or rest delivery-ep v2 somehow :notsureif:
Recently we have people reporting similar issue when using our REST delivery endpoint for site related workspaces.
The issue was:
the fallback site don't have theme to resolve image variations - MGNLREST-194 or
the fallback site was NOT extending main site configuration then the language filter is not working - SUPPORT-9407

--> The common point here is that site resolver didn't recognize the request so that it can use correct i18n supported node wrapper.

--> even though this is a usage issue but definitely we're making it difficult for customers to use it and they're making mistakes, let's find a way to make it easy by noting on Docs or implement it somehow

then somewhere on this page:
https://documentation.magnolia-cms.com/display/DOCS60/Delivery+endpoint+API+v2

 

Something in Mercedes' wording:

  • "When lang=all is used all the languages are returned, in case of lang=fr the site definition is taken into account, and as there is no configuration available the default language is returned in the request, that is English."

or Theodossios' : 

  • "REST calls not belonging to any site and therefore being served following the fallback site rules."

 

Consult maybe mgeljic for the final wording of the note / infobox.

 



 Comments   
Comment by Christoph Meier [ 07/Jan/19 ]

To be honest - I still have not understood what this ticket is asking for.

Who can clarifiy? viet.nguyen or miruela?

Comment by Viet Nguyen [ 07/Jan/19 ]

Hello cmeier,

2 things:

the fallback site was NOT extending main site configuration then the language filter is not working - SUPPORT-9407

--> Customers have to ensure that fallback site are extending a concrete site or fully configured correctly follow our site definition such as 'travel' demo site so that i18n related features could work correctly.

the fallback site don't have theme to resolve image variations - MGNLREST-194

--> Similarly for image variations which is i18n related topic, customers have to ensure that they have a concrete configured theme for fallback site or their fallback site must extends a fully configured one so that a 'theme' could be correctly resolved.

We could also put some known issue or trouble shooting topic related to this one because we are having people struggling with this, but this is not so high prior (except it relates to our internal Front end team and an SLA-3 customer), let's consider putting those info somewhere or having an automatic resolver for missing configured part of theme - theme fallback resolver for instance.

Hope this helps!

Comment by Ashraf Khamis [ 28/May/20 ]

 The following pages updated with notes about i18n features and image variations for fallback sites:

Reviewed by Mika. All changes backported to DOCS61, DOCS57 & DOCS56.

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