coralproject / talk

A better commenting experience from Vox Media
https://coralproject.net
Other
1.89k stars 358 forks source link

Dead link in moderation administration section #2772

Closed honzie closed 4 years ago

honzie commented 4 years ago

Expected behavior:

When I click on the link under 'Configuration' in the 'Toxic Comment Filter Section', I expect to learn more about how to set up the Perspective Comment API. The text on the page (en-US) is below:

"For additional information on how to set up the Perspective Toxic Comment Filter please visit: https://github.com/conversationai/perspectiveapi/blob/master/quickstart.md"

My expectation might be to go to https://github.com/conversationai/perspectiveapi/tree/master/1-get-started. However, there may be a better getting started guide—this is the one I could find in the repo.

The code is in admin.ftl files, nearly 3 dozen, since they are split across locales:

configure-moderation-perspective-accountNote =
  For additional information on how to set up the Perspective Toxic Comment Filter please visit:
  <externalLink>https://github.com/conversationai/perspectiveapi/blob/master/quickstart.md</externalLink>

Actual behavior:

I get a 404 at: https://github.com/conversationai/perspectiveapi/blob/master/quickstart.md

Related Issues:

I didn't see anything opened that looked similar

Versions:

honzie commented 4 years ago

I'd be happy to swap out the links, if someone on the team validates that the above link (https://github.com/conversationai/perspectiveapi/tree/master/1-get-started) is what is expected for Perspective API. There definitely might be a better one.

kgardnr commented 4 years ago

Hey @honzie thanks for catching this! We'd love if you could open a PR to swap this out.

Could you actually link is to this: https://github.com/conversationai/perspectiveapi#readme

I think that's more general and less likely to break if they update their docs links in the future.

Thank you!

honzie commented 4 years ago

Absolutely! That's a good idea. Probably a better link for sure.

kgardnr commented 4 years ago

Fixed in #2773