[DOCU-2713] Headless/SPA documentions are outdated Created: 03/May/23  Updated: 18/Oct/23  Resolved: 18/Jul/23

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

Type: Improvement Priority: Neutral
Reporter: David Gurk Assignee: Martin Drápela
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File 2023-05-03 12_54_54-.png     PNG File 2023-05-03 12_59_45-minimal-headless-spa-demos – angular.json.png     PNG File image-2023-05-11-09-45-56-981.png     PNG File image-2023-05-11-10-09-04-404.png     PNG File image-2023-05-15-13-30-01-211.png     PNG File image-2023-07-18-12-02-00-175.png    
Issue Links:
Cloners
is cloned by DOCU-2881 CLONE - Headless/SPA documentions are... Open
Documentation page URL: https://docs.magnolia-cms.com/headless/getting-started-with-Magnolia-headless.html

 Description   

While working through the "Get Started with Magnolia Headless" I found several issues.

  1. The installation is missing to mention which (LTS) version to use for Java and NodeJS.
  2. In "Create Tour List Component" the statement "Now we can already select the component in the Page Editor." isn't true. This state result in an error:The Frontend Component
  3. In "The Frontend Component" the Angular component creation failed, since the angular.json has a version mismatch with the schema.
    Unable to render embedded object: File (2023-05-03 12_59_45-minimal-headless-spa-demos - angular.json) not found.
  4. In general the examples seems a bit outdated. Angular 13 instead of 15, someone previously updated the version to 13, but didn't update the schemas. See 3.


 Comments   
Comment by David Gurk [ 08/May/23 ]

In "Create Tour List Component" the statement "Now we can already select the component in the Page Editor." isn't true. This state result in an error:The Frontend Component

I would appreciate a short-time fix, since it's a real blocker within the evaluation phase for Magnolia. This doesn't work at all. No "just add the files in light modules" and done 

EDIT:
Okay, I was able to fix that. Apparently Magnolia can't handle the old YAML file extension *.yml (was unfortunately still the default for me) and needs the file extension *.yaml.
My bad, sorry.

Comment by David Gurk [ 09/May/23 ]

Yes, this ticket should be worked on. Only no. 2 is solved. (I can't edit the description) The rest ist still relevant, in my opinion.

Comment by David Gurk [ 10/May/23 ]

This doc is more specific about the software versions
https://wiki.magnolia-cms.com/display/SERVICES/Setting+up+the+environment

You should streamline the docs.

Comment by Martin Drápela [ 15/May/23 ]

Postponing further updates, until we get fixes from the devs.

At the step https://docs.magnolia-cms.com/headless/getting-started-with-magnolia-headless/hello-spa.html#_the_frontend_component

I hit the following error:

Comment by Martin Drápela [ 18/Jul/23 ]

The React demo works correctly now,

tested with

  • Magnolia CE 6.2.36
  • Magnolia CLI: 4.0.4 (node.js: v19.9.0)

and

18-Jul-2023 10:17:08.457 INFO [main] org.apache.catalina.startup.VersionLoggerListener.log Server version name:   Apache Tomcat/9.0.76
18-Jul-2023 10:17:08.459 INFO [main] org.apache.catalina.startup.VersionLoggerListener.log Server built:          Jun 5 2023 07:17:04 UTC
18-Jul-2023 10:17:08.459 INFO [main] org.apache.catalina.startup.VersionLoggerListener.log Server version number: 9.0.76.0
18-Jul-2023 10:17:08.460 INFO [main] org.apache.catalina.startup.VersionLoggerListener.log OS Name:               Linux
18-Jul-2023 10:17:08.460 INFO [main] org.apache.catalina.startup.VersionLoggerListener.log OS Version:            5.15.0-69-generic
18-Jul-2023 10:17:08.460 INFO [main] org.apache.catalina.startup.VersionLoggerListener.log Architecture:          amd64
18-Jul-2023 10:17:08.460 INFO [main] org.apache.catalina.startup.VersionLoggerListener.log Java Home:             /usr/lib/jvm/java-11-openjdk-amd64
18-Jul-2023 10:17:08.460 INFO [main] org.apache.catalina.startup.VersionLoggerListener.log JVM Version:           11.0.19+7-post-Ubuntu-0ubuntu122.04.1

 

Comment by David Gurk [ 20/Jul/23 ]
  1. The installation is missing to mention which (LTS) version to use for Java and NodeJS.

This issue still applies.

Why React? The issues mentions Angular.

In "The Frontend Component" the Angular component creation failed, since the angular.json has a version mismatch with the schema.

Comment by Martin Drápela [ 20/Jul/23 ]

Ha, good point dgurk , ok, I ll create two new separate tickets to check both Angular and Vue envs.

 

As to the NodeJS + Java, there is currently https://jira.magnolia-cms.com/browse/MGNLFE-457 in review, which should provide the answers.

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