Error code links to support articles & docs

[mattheworiordan]

See https://github.com/ably/realtime/issues/1941, and the registry of error codes to URLs at https://github.com/ably/ably-common/blob/master/protocol/errorsHelp.json.

@tomczoink @Srushtika can you please take a quick stab at improving the lookup of common errors we are aware of, and any docs we have (this does not need to be an article per say, but useful of course).

Let's try and do that soon if you can, and then we can deal with new error codes as they come up (with notifications from Rollbar)

[tomczoink]

For this @mattheworiordan , are you wanting us to edit the errorsHelp.json file, adding in existing articles, and to then remember to add errors to it as we create new support articles for errors?

[mattheworiordan]

are you wanting us to edit the errorsHelp.json file

Yes, if you look at https://github.com/ably/help/blob/master/lib/errors_cache.rb#L2, the help app just loads the error codes & URLs dynamically.

adding in existing articles

Yes, ideally along with any common errors we've seen reported, such as rate limiting error codes. @paddybyers @SimonWoolf perhaps you could offer some advice on what are common error codes we should add articles for?

and to then remember to add errors to it as we create new support articles for errors?

Yes, if we have a corresponding error code. The help tool also reminds us as anyone clicking on an error code URL that does not exist creates an error in Rollbar, which in turn alerts us (if you have set that up)