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

NPM walkthrough - part 2

    XMLWordPrintable

Details

    • Story
    • Resolution: Done
    • Neutral
    • None
    • None
    • None
    • Docu Sprint 29, Docu Sprint 42, Docu Sprint 43, Docu Sprint 44, Docu Sprint 45
    • 13

    Description

      In the second part of the NPM walkthrough tutorial, provide step by step instructions on how to find (using the keyword magnolia-light-module), install and reuse an existing npm package within your own light-module.
      In part 2 of the tutorial the aim is to expand on part one by reusing an existing npm (magnolia-light-module) package within your own light-module:

      • Search for shared components in NPM using the "magnolia-light-module" keyword
      • Install google-maps-magnolia (by Mathias Muller winner of the npm contest)
      • Configure the module as instructed in MM's readme (pull instructions into doc)
      • Make his components available in the page template created in part 1.
      • Reuse it/them to display a map of where the bucket list item would happen.

      This ticket also covers the work required to tweak Part 1 of the tutorial:

      • Change the components created:
        • activity (currently component-A)
        • destination (currently component-B)
      • Add availability to the mtk component image (currently textImage)
      • Write an intro giving an overview of the example used in the tutorial.

      + add final result to git repo.

      Note: I think some of the content in the community wiki pages that are being pulled into doc as part of DOCU-1039 may overlap/conflict with what is planned to be documented in this ticket.

      See https://documentation.magnolia-cms.com/display/DOCU/NPM+CLI+walkthrough+meeting+notes for the bare bones structure and order of steps.

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                jlegendre Julie Legendre
                jlegendre Julie Legendre
                Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved: