ember-learn / ember-learn/ember-api-docs

Some internal links lead to server error pages

Offen
#613 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
🐞bug
Vorherrschende Sprache
JavaScript
Sterne
75
Forks
111
Ø Merge
45 Min.
Gemergte PRs (30 T.)
1

Beschreibung

I was looking at the page https://api.emberjs.com/ember/3.9/classes/Location, and when attempting to click on one of the links within the page resulting in the following server error:
`Cannot GET /api/ember/release/classes/HashLocation`

![Screen Shot 2019-04-27 at 12 18 11 AM](https://user-images.githubusercontent.com/1759897/56844678-2bb79700-6882-11e9-9cf7-3045ad0a6675.png)

The main issue being that the relative path defined in the ember.js repository is pointing to `/api/ember/...` instead of `/ember/...`. Removing the `/api` portion of the URL takes me to the correct location.

I have found that the issue on this particular page goes as far back as 2.16. Which, for the same link, gives the error `Cannot GET /api/classes/Ember.Location.HashLocation`.

![Screen Shot 2019-04-27 at 12 28 49 AM](https://user-images.githubusercontent.com/1759897/56844755-8271a080-6883-11e9-9909-dc9ff0dfeab9.png)

Again, removing the `/api` portion of the 2.16 URL does redirect me to the correct page on the current release.

There is the potential for an issue to be opened up on the ember.js repo to update the relative links within the documentation for the current release going forward, but figured I'd start here first.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, die defekten Links der Ember 3.9 Location-Seite zu reproduzieren und sie mit der entsprechenden 2.16-Seite zu vergleichen. Verfolge, wie der Viewer für die API-Dokumentation diese relativen URLs erstellt, und identifiziere, an welcher Stelle das zusätzliche /api-Segment eingefügt wird. Als erledigt gilt die Aufgabe, wenn die betroffenen Links über die gemeldeten Versionen hinweg auf die korrekten Dokumentationsseiten verweisen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
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.