[NPMCLI-63] CLI: Help users get started Created: 17/Jan/17  Updated: 20/Feb/17  Resolved: 10/Feb/17

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

Type: Epic Priority: Neutral
Reporter: Robert Kowalski Assignee: Federico Grilli
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Epic Name: CLI: Help users get started
Acceptance criteria:
Empty
Date of First Response:

 Description   

Help (new) users, often with frontend focus, be successful and get excited about magnolia and the possibilities it provides.

Successful and happy users are important. A frictionless setup for completely new users helps to set them up for success. Attention spans are short and frustration often leads to aborted evaluation of new technology.



 Comments   
Comment by Christoph Meier [ 19/Jan/17 ]

Hi rkowalski,
If i understand this epic and its sub-tasks correctly, you want to improve the instructions in the context of the cli tool (not talking about external documentation).

Right now the instructions are part of the corresponding "command files". I wonder whether it would make sense to have something like a resource bundle. Not sure whether that's a pattern which is used in the npm world and whether it generally would have a value. Atm i just share my thoughts.
I do not expect that we would internationalize the Magnolia CLI in the near or midterm future, however, if the texts would be in a central file. i could stream the file and read its values from Confluence to use them in the external documentation.

... just an idea ...

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