[DOCU-947] Explain how to share lightmodule as npm package - and how to search them on npm repos Created: 28/Feb/17  Updated: 01/Jun/18  Resolved: 01/Jun/18

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

Type: Task Priority: Neutral
Reporter: Christoph Meier Assignee: Unassigned
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:

 Description   

Please see the proposal from czimmermann on PMTEAM wiki:
LM Sharing Docs Page - Proposal

As far as i understood this task, we should explain in details:

  • How you can share your light-module as npm package
  • How you can find Magnolia light-modules on npm repositories


 Comments   
Comment by Christopher Zimmermann [ 28/Feb/17 ]

We need at least one page in magnolia docs on this topic. I need a place to send people to get started on the topic - and it should be in docs so that people feel that they are in the correct place. Currently i state in the README's of the example npm modules - search magnolia docs for "sharing light modules" - so the page should come up with that search phrase. (for example in this one https://www.npmjs.com/package/shareable-magnolia) I do that instead of a direct link because I worruy the link could change in the future.

We'll also have direct links to the page from the "component sharing contest" which is launching on this weds.

We can improve this page in the future - but I think it is an accurate, understandable, useful page to get started with. It can link to the community wiki where I will provide all of the explicit details that you ask for. I do those pages on the wiki for now - but that content should eventually move into docs as well.

I agree the intro is a bit "fluffy", but i think this context is important to the whole topic of sharing. Consider that this page is in a section of docs labeled "Contribute".

Comment by Christopher Zimmermann [ 28/Feb/17 ]

I've reduced the intro fluff. https://wiki.magnolia-cms.com/display/PMTEAM/LM+Sharing+Docs+Page+-+Proposal

Comment by Christoph Meier [ 29/May/18 ]

I assume this will be tackled by DOCU-1039 - that's why I propose to close that one.

czimmermann, jlegendre - would you agree?

Comment by Christopher Zimmermann [ 29/May/18 ]

Sure, fine with me.

Comment by Julie Legendre [ 01/Jun/18 ]

ok

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