ember-api-docs icon indicating copy to clipboard operation
ember-api-docs copied to clipboard

"findRecord" link on ember-data docs is dead

Open kurkowski opened this issue 5 years ago • 3 comments

Steps to Reproduce:

  1. https://api.emberjs.com/ember-data/release/classes/Store/methods/queryRecord?anchor=queryRecord
  2. Scroll down to "queryRecord" documentation.
  3. In the sentence "This method makes a request for one record, where the id is not known beforehand (if the id is known, use findRecord instead)", click "findRecord".

Expected: You're taken to the "findRecord" documentation

Actual: You're taken to this URL which doesn't load: https://api.emberjs.com/ember-data/release/classes/Store/classes/Store/methods/findRecord?anchor=findRecord with the error message: "Cannot GET /ember-data/release/classes/Store/classes/Store/methods/findRecord"

kurkowski avatar Oct 29 '20 00:10 kurkowski

Hello! @krashaune and I are pairing during the contributors workshop, and would like to work on this if someone could assign it to us, please. @jenweber ?

broxsonl avatar Mar 29 '21 17:03 broxsonl

@broxsonl just assigned that to you, thx! Feel free to ping me on Discord (same handle) if you need a hand there

acorncom avatar Mar 29 '21 18:03 acorncom

We've determined that there's actually at least half a dozen links--maybe more--that are broken due to incorrect pathing in their respective html-safe descriptions in the json artifact which builds the page. Will need to directly update the json to fix them.

Example for the issue this was created for:

[findRecord](../classes/Store/methods/findRecord?anchor=findRecord) is using a relative path, which is making the url "classes/Store/classes/Store/methods/findRecord?anchor=findRecord"

Means we likely need to update the path in the description in the json to [findRecord](../methods/findRecord?anchor=findRecord)

broxsonl avatar Mar 29 '21 19:03 broxsonl