Some internal links lead to server error pages
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- documentation
Research direction
Start by reproducing the broken links from the Ember 3.9 Location page and compare them with the corresponding 2.16 page. Trace how the API documentation viewer builds these relative URLs and identify where the extra /api segment is introduced. Done means the affected links resolve to the correct documentation pages across the reported versions.
Written by the indexing model from the issue text.
Description
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
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.
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.
- Dominant language
- JavaScript
- Stars
- 75
- Forks
- 111
- Avg merge
- 45m
- Merged PRs (30d)
- 1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ember-learn/ember-api-docs
-
🐹requires source yuidoc update
Difficulty 1/5 Under an hour Newbie friendliness 72/100
ember-learn/ember-api-docs#723 · 1 comment ·
-
Dependency Dashboard Open
Difficulty 5/5 Over a week Newbie friendliness 15/100
ember-learn/ember-api-docs#972 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
ember-learn/ember-api-docs#935 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 50/100
ember-learn/ember-api-docs#932 ·
-
Broken link Open
Difficulty 1/5 Under an hour Newbie friendliness 50/100
ember-learn/ember-api-docs#929 · 1 comment ·
All issues in ember-learn/ember-api-docs
Similar issues
-
curation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
amponce/archive-movie-browser#186 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
clerk/javascript#9852 ·
-
bug p1 tools
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
factory-active factory-automatic task-bug-reproduction-cannot-reproduce task-identify-harness-labels-done task-identify-issue-type-done
Difficulty 2/5 1-3 hours Newbie friendliness 84/100