Uploaded image for project: 'Magnolia CLI'
  1. Magnolia CLI
  2. NPMCLI-12

Polish and streamline commands doc and README.md

    XMLWordPrintable

Details

    • Task
    • Resolution: Fixed
    • Neutral
    • 0.0.1
    • None
    • None
    • Yes
    • Basel 57
    • 2

    Description

      All command help texts and the README.md needs a polishing.
      "At the end" these texts should also use the same wording as the docs page https://documentation.magnolia-cms.com/display/DOCS/Magnolia+npm-cli (or vice versa).

      One of the worst case is the help text of the build command which is using the term "Magnolia light module" (imho) completely wrong.
      In the build-command-context it means an npm-package with the Keyword magnolia-light-module.
      We really should use the term "Magnolia light module" with care consistent!
      This said, it is probably even not so good to use "Magnolia light module" as a keyword in the package.json

      A follow up to NPMCLI-10.

      README.md needs to be expanded with examples. Also review commands help output.

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                cmeier Christoph Meier
                fgrilli Federico Grilli
                Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Task DoR

                    Time Tracking

                      Estimated:
                      Original Estimate - Not Specified
                      Not Specified
                      Remaining:
                      Remaining Estimate - 0d
                      0d
                      Logged:
                      Time Spent - 0.75d
                      0.75d