[NPMCLI-12] Polish and streamline commands doc and README.md Created: 10/May/16  Updated: 22/Aug/16  Resolved: 16/Aug/16

Status: Closed
Project: Magnolia CLI
Component/s: None
Affects Version/s: None
Fix Version/s: 0.0.1

Type: Task Priority: Neutral
Reporter: Federico Grilli Assignee: Christoph Meier
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: 0d
Time Spent: 0.75d
Original Estimate: Not Specified

Issue Links:
dependency
relation
is related to NPMCLI-10 Refactor initial code Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Documentation update required:
Yes
Date of First Response:
Sprint: Basel 57
Story Points: 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.



 Comments   
Comment by Christoph Meier [ 10/Aug/16 ]

In this context docs - https://documentation.magnolia-cms.com/display/DOCS/Magnolia+npm-cli - must be checked.

Prbly. README.md and docs can be "married" somehow :-p

Comment by Christoph Meier [ 15/Aug/16 ]

I have aligned the command help-texts and the README.md with the docs. page.
Please note that the README.md does NOT complete examples. Instead it just explains generally the usage of the commands and how to get the per command specific help texts.
For more complete examples, people should check docs. page.

Generated at Mon Feb 12 04:45:40 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.