docs icon indicating copy to clipboard operation
docs copied to clipboard

Solutions articles that are exact duplicates of docs pages

Open SimonWoolf opened this issue 5 years ago • 2 comments

Just discovered https://www.ably.io/documentation/general/channel-rules-namespaces , which contains essentially the same content as https://support.ably.io/support/solutions/articles/3000030058-what-is-a-channel-namespace-and-how-can-i-use-them- .

Well... almost the same content. The solutions article was updated when we added push notifications as a namespace setting. The docs page wasn't. This is the issue with duplication - whoever updated the solutions article likely made the reasonable assumption that they had found the place that listed namespace settings, and stopped looking, so the other page didn't get updated.

I think we should delete one of them.

┆Issue is synchronized with this Jira Bug by Unito

SimonWoolf avatar Jun 01 '20 14:06 SimonWoolf

I am in favour of deleting the documentation page as it is not only out of date compared to the support article, but also not in the TOC of the docs, it is a hidden page as it were.

MarkWoulfeAbly avatar Jun 18 '20 10:06 MarkWoulfeAbly

Out of curiosity - if we were to make a decision where content like this should live, would it be within the docs or somewhere else?

I think the right place for such content is docs, and if it is "hidden" right now - we need to improve the navigation and docs structure.

The way I think about it is like lines of support:

  1. Docs is the first line of self support. If users don't understand something they are pretty likely to start with the docs. Docs should contain all definitions and feature documentation.
  2. "Support" content is the second line of self support. Users should only go here if the documentation is missing answer to their query. I imagine more sophisticated stuff can go in here, but definitely not "What is" kind of content.

Considering the above - I actually think removing the support page, and improving the structure and navigation within the docs is the right thing to do.

@MarkWoulfeAbly what do you think?

cc: @JackUkleja

kavalerov avatar Jun 18 '20 17:06 kavalerov