Improve docs for the Router Service

[jenweber]

The Router Service docs need a more beginner-friendly description. Right now it says:

The Router service is the public API that provides component/view layer access to the router.

I recommend that the "main" description be a PR on its own. This is the file that needs to change.

Ideally the most commonly used APIs should have code blocks demonstrating their use and some explanations of their purpose or how to use them. For example, see EmberArray. Additional PRs could include a code block demonstrating the use of each method or property.

Maintainers may feel free to edit this issue directly. @locks can you mark this help-wanted/new contributors if it looks good to you?

• Router service's urlFor does not respect default value of query param #16596

Tasks

• Methods
  • isActive (@rscotchmer) (@pauljeannot) [DOC] Update explanation of router service isActive method and add code example #18471
    • explanation
    • code sample
  • recognize
    • explanation
    • code sample
  • recognizeAndLoad
    • explanation
    • code sample
  • replaceWith (@teamdraftbox)
    • explanation
    • code sample
  • transitionTo
    • explanation
    • code sample
  • urlFor
    • explanation
    • code sample
• Properties
  • currentRoute (@sdebarros)
    • explanation (what's a RouteInfo?)
    • code sample (needs usage sample)
  • currentRouteName
    • explanation
    • code sample (needs usage sample)
  • currentURL
    • explanation
    • code sample (needs usage sample)
  • location
    • explanation (should link to different Location types)
    • code sample
  • rootURL
    • explanation
    • code sample (needs usage sample)
• Events
  • routeDidChange
    • explanation
    • code sample
  • routeWillChange
    • explanation
    • code sample

[Serap08]

Is this issue still open? if yes, I can contribute.

[amanriquez]

Looking for my first open source contribution, any help needed here?

[locks]

@amanriquez definitely! I have updated the original post with a list of what there is to document in RouterService and their current state.
Pick one item and I'll assign you to it :)

[locks]

@PrimeN thanks for the help! Please comment with the item you wish to take so we can assign it to you :)

[CDNRae]

Hello! I'd like to contribute to the project by writing up an explanation and code sample for the isActive method.

[locks]

@rscotchmer thanks for the help! I'll tag you in the list. Don't hesitate in sending over a work in progress PR if you want some feedback from the team :)

[locks]

Hi @Serap08, @amanriquez and @PrimeN, can you pick one item from the task list so I can assign them to you? That way we avoid several people working on the same item!

[teamdraftbox]

hey @locks im looking to contribute to the above mentioned issue, this is my first time in contributing to a open source, i would like to work on replaceWith method issue, please let me know what exactly is the procedure so i can start working on it

[mschinis]

☝️ happy to take transitionTo here, tomorrow at the EmberConf Contributors Workshop

[locks]

@Serap08 @amanriquez @PrimeN @mschinis poke poke :)

@teamdraftbox hi, thanks for your interest!
The way to start is:

1. comment on this thread which part you want to take on (done!)
2. fork the repository
3. create a branch with a name of your choosing, for example git checkout -b router-replace-with
4. open ember.js/packages/@ember/-internals/routing/lib/services/router.ts
5. add your documentation changes
6. git commit your changes
7. push the branch to your github fork
8. go to your fork on github.com, and you should see a banner telling you to create a new PR. click the create button
9. wait for our review!

If you need further help, reach out to #dev-ember-learning on the Discord server!

[teamdraftbox]

Hi, Thanks for the instructions,will follow the above instructions Will be taking replaceWith method issue,

…

On Wed, Mar 27, 2019 at 12:44 AM Ricardo Mendes ***@***.***> wrote: @Serap08 <https://github.com/Serap08> @amanriquez <https://github.com/amanriquez> @PrimeN <https://github.com/PrimeN> @mschinis <https://github.com/mschinis> poke poke :) @teamdraftbox <https://github.com/teamdraftbox> hi, thanks for your interest! The way to start is: 1. comment on this thread which part you want to take on (done!) 2. fork the repository 3. create a branch with a name of your choosing, for example git checkout -b router-replace-with 4. open ***@***.***/-internals/routing/lib/services/router.ts 5. add your documentation changes 6. git commit your changes 7. push the branch to your github fork 8. go to your fork on github.com, and you should see a banner telling you to create a new PR. click the create button 9. wait for our review! If you need further help, reach out to #dev-ember-learning on the Discord server! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#16518 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/Adi9n30bTOvG_mJMszE_qIURBZG-D3c7ks5vanF9gaJpZM4TU57b> .

[madzadev]

i would love to contribute on this

[locks]

@madarsbiss have you picked a specific method/property so I can assign you?

[sdebarros]

✋ I'll take currentRoute for documenting.

[sdebarros]

✋ will be also working on the location property docs

[pauljeannot]

🤚 Took the nice work done by @rscotchmer, and updated it with new class syntax, for the isActive method.

[esbanarango]

Can I take transitionTo code sample? ✋

[locks]

@esbanarango hi :) have you sent a PR yet?

[esbanarango]

@locks looks like the code sample was already added here: #18179 We could update the description of this issue. Check code samples for transitionTo, replaceWith and recognize.

[RVMac]

Hi, I'm looking to contribute (I'm a beginner BTW). Any task needed to be done?

[locks]

Thank you everyone for your help! I believe we have done enough work to close this issue :)