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

Update Mag Frontend Development section

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Closed
    • Priority: Neutral
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:
    • Sprint:
      Docu Sprint 20
    • Story Points:
      1

      Description

      Update section to match the latest CLI version, and ensure smoothest possible hour-1 learning experience.

      Motivation
      With our booth at the React London conference, our main "call to action" for visitors will be to get devs to "try it in 1 hour" by visiting the new frontend section with this handy link http://magnolia-cms.com/start-ld

      Details

      On On https://documentation.magnolia-cms.com/display/DOCS/Install+Magnolia

      Change message to make sure user experience matches the CLI
      Change: If you already installed Magnolia CLI and want to update to the latest stable version, use:
      To: If you already installed Magnolia CLI, update to the latest version: DONE

      Update help output
      mgnl help has different output now.DONE

      Update the jumpstart output to:
      info Magnolia has been successfully setup for light development!
      info You can now open a new terminal tab or window and start it up with the CLI command 'mgnl start'
      info Magnolia will be ready after a few seconds at localhost:8080/magnoliaAuthor. Username and password is superuser DONE

      Simplify Start
      Start Magnolia section can be very reduced because of introduction of mgnl start command.

      • Remove tip bullet: "Remember the path to the bin directory....."
      • Remove all the details under "Start Magnolia", because not necessary anymore.
      • Add "Execute the Magnolia CLI start command:" mgnl start
      • Add "On the first start, Magnolia will run the "web update" and automatically install all modules."
        DONE

      Update "Install Magnolia" section
      Just remove the whole section - they can go straight to the Login step.
      DONE

      Remove or simplify tip about "light modules" directory.
      Suggestion "The jumpstart command automatically creates a light-modules directory for you. If you already have a different directory that you want to use for light modules, edit the magnolia.resources.dir property in your magnolia.properties file to point to it."
      DONE

      On: https://documentation.magnolia-cms.com/display/DOCS/Hello+Magnolia+for+front-end+developers

      Conclusion
      There should be a bit more of a concrete end. They have finished the intro section and the tutorial, and now understand the basics and could create their own componnts. Right before the "Go further" section.
      Suggestion:
      Congratulations
      You have finished the "Get Started" section for front end developers, and have learned the key Magnolia concepts.
      DONE

      Go Further
      Add two bullet point to the top:
      Hello Magnolia - A step by step walkthrough of creating the Hello Magnolia light module.
      CLI Overview - Watch the CLI Video to learn how to quickly create modules, and page and component templates
      DONE

        Checklists

        Acceptance criteria

          Attachments

            Activity

              People

              Assignee:
              jlegendre Julie Legendre
              Reporter:
              czimmermann Christopher Zimmermann
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: