question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. ItΒ collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Update documentation to link to new URL API docs structure

See original GitHub issue

So for each package in ember source, we’d like to convert api doc links to our new url structure (example: https://emberjs.com/api/ember/release/classes/Application)

Additionally we’d like to convert references to old Ember namespaced classes to their simplified post RFC 176 names.
(example: documentation might refer to Ember.Object, while we’d want it to be EmberObject now) See the readme for https://github.com/ember-cli/ember-rfc176-data for the mappings.

here’s a list of all subdirectories in the packages/ directory. There may or may not be things to convert in some of these. if you verify these are not in need of conversion we can check them too.

Indicate in comments when you want to work on a directory and its yours. We will add your name to the item. Also when you submit a PR, mention this issue β€œ#15723” so that the link shows up here.

Thanks and Happy coding!

Update: Be sure to prepend your commits to [doc beta], so we can get these changes into 3.0! See https://github.com/emberjs/ember.js/blob/master/CONTRIBUTING.md#documentation

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Comments:27 (18 by maintainers)

github_iconTop GitHub Comments

3reactions
toddjordancommented, Jan 30, 2018

Looks like we can close the book on this one. Thanks so much @ynotdraw @Parrryy @karthiick @MarcoUmpierrez @williamhaley for making it happen. It was cool to see it come together ❀️

2reactions
Parrryycommented, Jan 22, 2018

I can do the ember-application, it’ll be my first contribution. Seems like a good one to start.

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to Write API Documentation: Best Practices and Examples
Today we will talk about how to foster positive developer experience in the API documentation. But first, we need to understand what makes...
Read more >
Links - Swagger
Links are one of the new features of OpenAPI 3.0. Using links, you can describe how various values returned by one operation can...
Read more >
REST Resource: documents | Google Docs
Can be used in update requests to specify which revision of a document to ... A reference to another portion of a document...
Read more >
Document.URL - Web APIs - MDN Web Docs
The URL read-only property of the Document interface returns the document location as a string.
Read more >
API design: Why you should use links, not keys, to represent ...
If your API allows clients to create new entities using PUT, you have to document the rules for composing new URLs, probably by...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found