Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCU-2951

SPA tutorial confusing note about Angular CLI

    XMLWordPrintable

Details

    • Task
    • Resolution: Fixed
    • Normal
    • None
    • None
    • None
    • None

    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

       

       

      Checklists

        Acceptance criteria

        Attachments

          Activity

            People

              amansell Alex Mansell
              tmiyar Teresa Miyar
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Checklists

                  Task DoR