[DOCU-1189] Update "Accessing content on the client side" by using delivery endpoint Created: 17/Oct/17  Updated: 03/Apr/18  Resolved: 29/Mar/18

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

Type: Story Priority: Neutral
Reporter: Julie Legendre Assignee: Christoph Meier
Resolution: Done Votes: 0
Labels: underestimated
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
causality
is causing DOCU-1393 Publish related doc for 5.6.4 Closed
relation
is related to DOCU-1364 REST 2.1 updates Closed
Template:
Acceptance criteria:
Empty
Date of First Response:
Epic Link: Reflect REST 2.0 updates
Sprint: Docu Sprint 43, Docu Sprint 44, Docu Sprint 45, Docu Sprint 46
Story Points: 5

 Description   

A tutorial showing how to consume content via nodes endpoint with an Angular 1.x client application.

Update the example.

Instead of nodes use the delivery endpoint.
This also requires a configuration for this endpoint.
No more need to "re-format" JSON on the client side and ease od use of the deiliverd json.

Refine Section Same-origin policy
Instead of recommending Lars' CORS filter - now we can use the new AddHeadersFilter; see MAGNOLIA-7229.

Edit:
Now the changes also must reflect latest rest version 2.1



 Comments   
Comment by Christoph Meier [ 22/Feb/18 ]

New code

Since the angularjs code had to be changed - I was creating a completely new light module with the new code (in order to keep the old one for the tutorials on DOCS55 and DOCS54).

On both git repos I have adapted the README files - which also should be reviewed

copy of the page for DOCS56

The new version of the tutorial for DOCS56 is there:
Accessing content on the client side - using delivery endpoint

The parts dealing with installation ...

  • Install Magnolia REST
  • Install sample content

probably should be merged. In any case - "Install Magnolia REST" still needs some updates. It depends whether we recommend using CLI-3 + webapp without demo ... or whether we wait for the next REST versions which allows multiple delivery endpoint definition.
This may also have an effect on the section "Configuring Delivery Endpoint" - which currently "explains" the decoration of the tourFinder. It would be much more nicer to have a version which doesn't need decoration.

Comment by Christoph Meier [ 29/Mar/18 ]

Result: https://documentation.magnolia-cms.com/display/DOCS56/Copy+of+Accessing+content+on+the+client+side+-+new

 

I am especially curious how the reviewer thinks about the section
"Installing a Magnolia bundle with the content app app-tutorial"

Tip: Indeed use CLI humpstart to install the bundle. Use the -s option for a 5.6.4-SNAPSHOT bundle

 

Comment by Julie Legendre [ 29/Mar/18 ]

lang review done, not tested

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