[DOCU-965] Promote Magnolia CLI where appropriate Created: 15/Mar/17  Updated: 03/Jul/17  Resolved: 31/Mar/17

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Story Priority: Neutral
Reporter: Julie Legendre Assignee: Ruth Stocks
Resolution: Done Votes: 0
Labels: core
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: Not Specified Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Issue Links:
relation
Sub-Tasks:
Key
Summary
Type
Status
Assignee
DOCU-976 Identify pages to promote CLI Sub-task Closed Ruth Stocks  
DOCU-977 Add boxes to appropriate pages promot... Sub-task Closed Ruth Stocks  
Template:
Acceptance criteria:
Empty
Date of First Response:
Sprint: Docu Sprint 20, Docu Sprint 21
Story Points: 8

 Description   

Write a snippet (tbc) about the benefits of using CLI for common tasks such as creating components, pages and assigning availability. Use this snippet to promote CLI on the following pages at least:

  • Template definition
  • Dialog definition

+ Check through the actions offered by CLI and add information to any other pages affected too.

Stems from a comment from Jan:
"Jan Haderka·9:04 AM

when discussing things yday with some external devs, we realized that they often don't know about cli and how easy it makes to create components/pages/assign availability etc.
trying to undestand why/how they don't find the info about it despite the docu, videos, all the advertising elsewhere, we realized that what they do is searching for solution to concrete issues (create this or that dialog/component/ etc) and arrive at docu because docu is well indexed by search engine, but it points them to pages describing how to do things manually.
I was wondering if it would not be beneficial to have on top of such pages tips showing one liner command on how to do the same w/ cli (similar to how we describe how to create module, while also offering alternative w/ using command with archetype)
... just some food for thoughts "



 Comments   
Comment by Ruth Stocks [ 31/Mar/17 ]

See subtasks for list of links

Comment by Julie Legendre [ 04/Apr/17 ]

I'd agree with that approach mdrapela, if ruths thinks there is enough repetition (present and future) for it to be worth the effort. The google sheet already provides a list of what's used where.

Comment by Ruth Stocks [ 04/Apr/17 ]

jlegendre mdrapela There is no repetition at all. Each box is unique. For me the benefit would be "knowing where the boxes are" if we need to update them. Seems a bit of a laborious exercise just to achieve this. Any other suggestions?

Generated at Mon Feb 12 01:13:56 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.