search

mckinsey / vizro

Vizro is a toolkit for creating modular data visualization applications.
https://vizro.readthedocs.io/en/stable/
Apache License 2.0
2.49k stars 112 forks source link

Rename docs pages that include `_` to use `-` #313

Closed stichbury closed 5 months ago

stichbury commented 5 months ago

Google doesn't recognise underscores as word separators when it indexes pages. So if we have a page called first_dashboard then Google will report that as firstdashboard to its algorithm. (If we had first-dashboard then it would go into the mix as first dashboard which earns more google juice for the keywords "dashboard"). More explanation here

As we are at an early stage with Vizro, we can make some changes (and use RTD redirects to ensure we don't break anyone's links) that set the docs up for success later. SEO doesn't seem that important but every little helps.

Solution

  1. Rename pages
  2. Set up redirects in readthedocs to redirect to newly hyphenated pages for external users who have bookmarks, and blog posts we can't update etc.
  3. Change all existing internal linking within the docs to the new page names
antonymilne commented 5 months ago

This is a great idea 👍 💯

I'm notworried about doing redirects for everything since we're at an early stage and I think this would break links for very, very few people, but I guess looking at the RTD analytics will help to see which the popular pages are and we can do redirects for just those.

stichbury commented 5 months ago

https://github.com/mckinsey/vizro/pull/321