ember-learn / ember-learn/ember-cli-addon-docs

Ember Data is a secret dependency breaking consumers of ec-addon-docs

Offen
#818 6 Kommentare 11 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
bug
Vorherrschende Sprache
JavaScript
Sterne
172
Forks
142
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

It's marked as a `peerDependency`, but it is required for ec-addon-docs to run properly. If the consuming project does not have `ember-data` in its package.json, ec-addon-docs breaks and throws an error, and the docs will not render. However, we can't specify it as a dependency within ec-addon-docs, either.

Addons do not ship with ember-data by default, as it is not part of the addon blueprint. Most addons don't have a need to install it either, as most addons won't be doing any data fetching. So, we cannot count on ember-data to be present in order to ship a working experience to users of this project.

There are three possible solutions which could be used in conjunction with one another:

1) Update the documentation for ec-addon-docs to explicitly ask users to install ember-data as part of the setup guide.
2) Add ember-data to the blueprint so that installing ec-addon-docs ensures ember-data is also installed, when using `ember install`
3) Use version checker to have addon-docs throw an error if a valid version of ember-data (currently 3.0+) is not present in the consuming addon.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit dem ec-addon-docs-Setup-Leitfaden, dem Addon-Blueprint und den im Issue genannten Einstiegspunkten für die Versionsprüfung. Vergleiche die drei vorgeschlagenen Ansätze und bestätige, wie die Addon-Installation und das Rendern der Dokumentation derzeit mit ember-data umgehen. Als abgeschlossen gilt die Arbeit, wenn der ausgewählte Ansatz implementiert ist und Verbraucher entweder eine funktionierende Dokumentationserfahrung oder einen eindeutigen Fehler für eine gültige Version erhalten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation, tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.