medusa icon indicating copy to clipboard operation
medusa copied to clipboard

Medusa Plugins Documentation

Open lack-of-gravitas opened this issue 2 years ago • 1 comments

Preliminary Checks

  • [X] This issue is not a duplicate. Before opening a new issue, please search existing issues: https://github.com/medusajs/medusa/issues

Issue Summary

Attempting to add medusa/packages/medusa-plugin-discount-generator/ to my vanilla install of medusa.

I've got medusa server and medusa admin UI running and have added the above package via yarn (and updated medusa-config js).

Is there documentation on this plugin and how to expose it via the Admin UI -- or am I expected to understand and expose this functionality by trawling through the package code?

This applies to the other lightly / undocumented plugins -- e.g. sendgrid / mailchimp which appear to do "nothing" on the Admin UI frontend.

How can this issue be resolved?

Provide documentation for medusa plugins and exposing via Admin UI (where applicable).

Are you interested in working on this issue?

  • [ ] I would like to fix this issue

lack-of-gravitas avatar Aug 24 '22 12:08 lack-of-gravitas

Just to be sure, you are looking for improved documentation around the plugin right? You did get it up and running with issues

olivermrbl avatar Aug 31 '22 14:08 olivermrbl

Can anyone share what medusa-plugin-discount-generator plugin does at high level?

kaushalyap avatar Oct 14 '22 10:10 kaushalyap

Hi, I can only create documentation on Medusa plugins, but I can't expose them via admin UI. Should I still proceed with the issue?

Edybee avatar Oct 15 '22 19:10 Edybee