search

eBay / ebayui-core

Collection of Marko widgets; considered to be the core building blocks for all eBay components, pages & apps
https://ebay.github.io/ebayui-core/
Other
217 stars 99 forks source link

Docs: following Marko Widgets v7 link leads to confusion #561

Closed aturpeinen closed 4 years ago

aturpeinen commented 5 years ago

Bug Report

eBayUI Version: x.x.x

Description

Workaround

Screenshots

aturpeinen commented 5 years ago

I used marko create my-app and npm install @ebay/ebayui-core and skin. Then npm start. Application worked well until I added following code to index.marko file:

Price Time Distance

Error: Unable to compile template at path "...\my-app\node_modules\@ebay\ebayui-core\dist\components\ebay-menu\template.marko". Error: el.addDynamicAttributes is not a function.

Documentation is bad.

package.json contains: "@ebay/ebayui-core": "^2.0.3", "@ebay/skin": "^7.0.1", "marko": "^4.13.10", "marko-starter": "^2.0.4", "marko-widgets": "^6.6.6"

DylanPiercey commented 5 years ago

The very first thing mentioned in the readme for this project is it’s requirements. There you can see that when using ebayui with Marko 4 you also need to have marko-widgets@7 installed (this is the Marko v3 compatibility layer for use in v4).

I don’t think the documentation is lacking there.

Can you trying installing the correct dependencies and letting us know if there is still an issue?

aturpeinen commented 5 years ago

Ok, thanks for letting me know that I should use @7. I saw "Marko v4 requires Marko Widgets v7" link on EbayUI ui page, that link leads to https://github.com/marko-js/marko-widgets/tree/v7. That page already shows "deprecated", and it shows "6.6.6". Does not say anything about @7 ? "See the new components docs on markojs.com." Components link is incorrect, it leads to 404.

ianmcburnie commented 5 years ago

It seems that following the link is what leads to the confusion. We'll see what we can do to make that a less confusing experience. Thanks for reporting this. I'll update the title of this bug so we can track.

ianmcburnie commented 4 years ago

I think we can close this one. Besides, the page in question belongs to Marko ;-)