[DOCU-2951] SPA tutorial confusing note about Angular CLI Created: 13/Dec/23  Updated: 15/Dec/23  Resolved: 15/Dec/23

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

Type: Task Priority: Normal
Reporter: Teresa Miyar Assignee: Alex Mansell
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File angular-tab.png     PNG File note-should-be-in-react.png    
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:

 Description   

Following the instructions on this page about installing a demo https://docs.magnolia-cms.com/headless/getting-started-with-magnolia-headless/hello-spa.html#_install_the_spa

 

The note to "Install the dependencies either with npm or yarn, and do your first build. For example, to install Angular CLI, you need to run npm install -g @angular/cli." is confusing as it implies that there is a step for all of the editor flavors, but actually it is only relevant for Angular. A developer may then go searching on the web trying to figure out what to do in this step if using React or Vue.

 

Recommendation:

As this step is ONLY relevant for Angular -

  1. Remove the note.
  2. Add another step in the Angular tab. I don't think any explanation is needed, its just a step to be completed.

So I would add a step after the cd, and before the "npm install":

npm install -g @angular/cli

 

 


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