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

DOC: Create an abridged version of the Hello Magnolia tutorial

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • Neutral
    • None
    • None
    • None
    • None

    Description

      Aims for the abridged version (from brainstorming session with Martin):

      • Single page
      • Hello in 5 to 10 minutes
      • Blocks (particularly yaml files) provided, user puts them together
      • Two column format - left: descriptions, right: links to files + screenshot focussing on something described on the left
      • No code, no CSS, no i18n labels - where should things be put, what should they be called
      • Focus on which files, what does what, where are they saved?
      • Don’t go into the contents of files

      Descriptions of files - 3 sentence format

      1. You need a dialog definition file
      2. A dialog defintion does this
      3. It needs to be saved [...]

      Starting ideas:

      1. Final page, what creates that page, in your light-modules folder you’d have …
      2. cli installation, quick installation
      3. Makes sure node.js is on your computer, if not install it.
      4. Create light module (right side show folder structure to where it is)
      5. Page template, what it does, and where it goes (right side template resides in this position, just put it there…)
      6. 5 x 2 table

      Checklists

        Acceptance criteria

        Attachments

          Activity

            People

              abrooks Adrian Brooks
              abrooks Adrian Brooks
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Checklists

                  Task DoR