ckeditor5 icon indicating copy to clipboard operation
ckeditor5 copied to clipboard

More graceful handling of people landing in the legacy method guides

Open Reinmar opened this issue 1 year ago • 5 comments

The warning at the top of this guide is hard to spot:

I mean the yellow one in the content of the guide.

The huge problem here is that people Googling for "ckeditor5 vite" will most likely end up here. AFAIK, there's no way to deprioritize those results in Google other than by robots.txt.

Moreover: the info box does not actually give the short answer. It sends the reader to the quick start guide where that person won't find a definitive answer for the question "how to  ... with vite".

I think there are ~3~5 things we should do:

  • Add sth like the :warning:  sign (can be just a unicode char) at the beginnig of those specific warnings. This should make them stand out a bit more.
  • Clean up the content below those warnings so there are fewer callouts. The more callouts, the fewer will be read.
  • Improve the messaging in these warnings giving straight and quick answers and then sending to reasonable places in the new docs.
  • Add a guide about supported bundlers and have as many covered with short and simple sections explaining that "All's good" and giving quick links to what to read next. This is to target basic SEO.
  • Consider listing (disallowing crawling) the legacy guides in robots.txt.

Reinmar avatar Jun 10 '24 12:06 Reinmar

  • Consider listing (disallowing crawling) the legacy guides in robots.txt.

We'll need to discuss this. I'm not sure about the consequences. These are new pages, but their content was copied 1-to-1 from the current documentation. Those pages that we want to delist are currently the highest performing guides.

Reinmar avatar Jun 10 '24 12:06 Reinmar

Add a guide about supported bundlers and have as many covered with short and simple sections explaining that "All's good" and giving quick links to what to read next. This is to target basic SEO.

This should be some longer Installation guide that we have in the setup section that goes deep into this and ESM and other topics.

Witoso avatar Jun 10 '24 12:06 Witoso

We redirected many of the old guides (like Quicks start) so that the old location of the legacy guides leads to the new ones instead and it will take some time before the legacy one list again in google. This will be our advantage.

There's been really few guides that have just been copied (like toolbars), most have been rewritten or written from scratch even if the names were similar.

The infobox would probably fare off much better with a link to migration guide (when we put those infboxes in 6 months go none of that ws ready and the QS was an empty placeholder). That's as close as we get to the "short answer" unless we put individual links in all individual infoboxes, which is also a solution.

godai78 avatar Jun 11 '24 04:06 godai78

Let's start with:

  • Add sth like the :warning:  sign (can be just a unicode char) at the beginnig of those specific warnings. This should make them stand out a bit more.
  • Clean up the content below those warnings so there are fewer callouts. The more callouts, the fewer will be read.
  • Improve the messaging in these warnings giving straight and quick answers and then sending to reasonable places in the new docs (link to corresponding guide React > React).

Witoso avatar Jun 11 '24 08:06 Witoso

We changed info boxes, added them to a few more places, tweaked titles. The framework section may need a few more infoboxes but it's not a blocker.

Witoso avatar Jun 24 '24 11:06 Witoso

LGTM

Reinmar avatar Jul 14 '24 22:07 Reinmar