Update documentation to link to new URL API docs structure

[locks]

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!

• container 🔒 @Parrryy
• ember-glimmer 🔒 @Parrryy
• ember-views 🔒 @Parrryy
• ember 🔒 @MarcoUmpierrez
• ember-metal 🔒 @Karthiick
• external-helpers 🔒 @Parrryy
• ember-application 🔒 @Parrryy
• ember-routing 🔒 @ynotdraw
• internal-test-helpers 🔒 @ynotdraw
• ember-console 🔒 @ynotdraw
• ember-runtime 🔒 @ynotdraw
• loader 🔒 @ynotdraw
• ember-debug 🔒 @williamhaley
• ember-template-compiler 🔒 @ynotdraw
• node-module 🔒 @ynotdraw
• ember-environment 🔒 @ynotdraw
• ember-testing 🔒 @ynotdraw
• ember-extension-support 🔒 @ynotdraw
• ember-utils 🔒 @ynotdraw

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

[scissorsneedfoodtoo]

Hi there. I'd like to help out with this task, but I'm quite new to ember.js and contribution. Could you point me toward the documentation that needs to be updated and the new URL structure?

[tinoromero]

Hi! Is this issue taken? I can help!

[toddjordan]

@scissorsneedfoodtoo @juventinoromero Thanks for your willingness to help! What needs to happen is any link referring to a legacy API url, (such as emberjs.com/api/ember/Ember.Application.html) needs to be replaced with its new equivalent (https://emberjs.com/api/ember/release/classes/Application).

Unfortunately, referring to links with release vs a specific version 2.17 has regressed, and we need to address this before proceeding with this fix.

See: ember-learn/ember-api-docs#407

Once fixed, we can split up the work by source folder. Will create a quest-issue style checklist for this and you can grab sections of the source by folder.

[tinoromero]

Ok. Thanks! I'll check that issue.

[scissorsneedfoodtoo]

@toddjordan, sorry for the late response, and thank you for such a detailed message.

@juventinoromero, go for it! I've gotten wrapped up in some other projects. Good luck with everything!

[tinoromero]

@scissorsneedfoodtoo thanks! I'll be working on it once I get some time off another project. Feel free to work on it too :)

[LukeBousfield]

@scissorsneedfoodtoo can I work on this?

[toddjordan]

@scissorsneedfoodtoo @juventinoromero @CodingPower472 The update to apidocs that supports the "release" url is just in and deployed today, so we can go ahead and convert links from the inline documentation. I'd suggest breaking up by directory so folks can work concurrently as they get band with. I'll update the description to make it more "quest" style.

But yes, feel free to start @CodingPower472

[LukeBousfield]

@toddjordan Is this an issue with ember-learn/ember-api-docs or emberjs/ember.js? (Sorry for the stupid question)

[Serabe]

Please, before starting with any part, ask here to lock it so we don't duplicate efforts.

Thank you!

[toddjordan]

@CodingPower472 its here in ember.js because all the code changes need to be made in this repo, to the inline documentation.

[ynotdraw]

I can lend a hand. I'll start with the bottom three:

• ember-testing
• ember-extension-support
• ember-utils

[scissorsneedfoodtoo]

@CodingPower472, @ynotdraw, go for it! I'm a bit wrapped up in another project now.

[tinoromero]

@CodingPower472 @ynotdraw go ahead! I'm also busy with another project but a week or so. I'll catch up with you later. Thanks!

[williamhaley]

Can I take on ember-debug?

[toddjordan]

sure can @williamhaley let me know if you have questions!

[toddjordan]

check out @ynotdraw 's pr for an example of what needs to be done #16108

[jenweber]

Similar work being tracked in emberjs/guides#2177 for the Guides

[ynotdraw]

I should have some bandwidth this week/weekend for another set. Feel free to assign these to me:

• ember-template-compiler
• node-module
• ember-environment
• loader

[ynotdraw]

Looks like the following do not require any RFC176 or url updates and can be marked off the list:

• ember-template-compiler
• node-module
• ember-environment
• loader

I'll move on to the next three that appear to need changes:

• ember-routing
• internal-test-helpers
• ember-console

[karthiicksiva]

I will take ember-metal package.

[MarcoUmpierrez]

ember package looks like it doesn't require any change either. There's only one file in that package (index.js) and no links pointing to the API docs.

Edit: There were some references to the global API. I made a PR for it 😄

[Parrryy]

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

[Parrryy]

I'll pick up container, ember-views and external-helpers today.

[Parrryy]

container and external-helpers have no changes that I can see. So will pick up ember-glimmer.

[toddjordan]

Thanks to everyone who's submitted prs/looked at packages ❤️ I'll be doing some reviews this evening.

[toddjordan]

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 ❤️