data icon indicating copy to clipboard operation
data copied to clipboard

Fixing broken links in docs

Open MichalBryxi opened this issue 2 years ago • 2 comments

When I try to click links that I'm touching in this PR on the page: https://api.emberjs.com/ember-data/4.6/classes/Store

I will get to: https://api.emberjs.com/ember-data/4.6/methods/createRecord?anchor=createRecord which fails with: Cannot GET /ember-data/4.6/methods/createRecord.

etc.

I'm not 100% sure this is correct. I just hand-crafted this PR straight from github following the existing paths. If someone can double-check that would be awesome.

Description

Type of PR

What kind of change is this?

  • [ ] refactor
  • [ ] internal bugfix
  • [x] user-facing bugfix
  • [ ] new feature
  • [ ] deprecation
  • [ ] documentation
  • [ ] something else (please describe)
  • [ ] tests

Notes for the release

Does this PR need to be described in the Ember release blog post? Please briefly describe what should be shared.

MichalBryxi avatar Sep 30 '22 17:09 MichalBryxi

The CI is not happy with:

Select at least one label for what release channels to target. Use the label target:canary and none of the others in the list if this PR should not be backported. ['target:canary', 'target:beta', 'target:release', 'target:lts', 'target:lts-prev']

I can't edit GitHub labels on the PR though. How do I ... label it?

MichalBryxi avatar Sep 30 '22 17:09 MichalBryxi

Hmm observation from today's experiments: The links will appear on different URLs, because of index / methods / properties tabs on the page. Then one will get two different sets of links:

Tab Link
index https://api.emberjs.com/ember-data/4.6/methods/createRecord?anchor=createRecord
methods https://api.emberjs.com/ember-data/4.6/classes/methods/createRecord?anchor=createRecord
properties https://api.emberjs.com/ember-data/4.6/classes/methods/createRecord?anchor=createRecord
correct URL https://api.emberjs.com/ember-data/4.6/classes/Store/methods?anchor=createRecord

I think that this might be a challenge to create correct link irrespective to at which tab the user is looking?

MichalBryxi avatar Feb 10 '24 17:02 MichalBryxi