[Development] Harmonizing the Qt 5.x Documentation

Thomas McGuire thomas.mcguire at kdab.com
Thu Apr 3 10:47:51 CEST 2014


Hi,

On Thursday 03 April 2014 08:02:16 Rutledge Shawn wrote:
> On 2 Apr 2014, at 6:07 PM, Ariel Molina wrote:
> > The current state of Qt docs is very sad, making online searches near to
> > useless. All Google searches refer either to broken pages, to 4.x doc
> > pages, to incomplete 5.0 unstables or even to 3.3 documentation. What's
> > the point on having 5.x (or any) docs if you keep moving them around
> > hiding it from search engines and breaking links on every site that
> > links to you?
> > 
> > You might point a root folder, but, let's be honest, none uses any root
> > folder to search, everyone uses Google or another search engine.
> > 
> > Please whatever you do, do not break this anymore, the current state is
> > already messed up.
> 
> I agree.  But I think the idea was to change it one last time and then
> never change it again, and the docs that google finds should be always the
> latest rather than a particular version.  I hope that goal is achieved...

Moving around is fine, but please make sure old links redirect to the new 
places. It is not just Google results affected by moving around docs, it is 
also links in other places like answers in Stackoverflow questions.

And yes, the fact that Google finds old versions is a problem. For example a 
search for "qprocess setreadchannel" will give the 4.8 version as the first 
result. How about adding a "Versions" box to the sidebar that gives convenient 
links to all other versions of the QProcess documentation? Then even if Google 
finds an old version first, the user can quickly jump to the newest.
Btw, any idea why Google prefers the 4.8 version?

Regards,
Thomas
-- 
Thomas McGuire | thomas.mcguire at kdab.com | Software Engineer
KDAB (Deutschland) GmbH&Co KG, a KDAB Group company
Tel. Germany +49-30-521325470, Sweden (HQ) +46-563-540090
KDAB - Qt Experts - Platform-independent software solutions

Join us in October at Qt Developer Days 2014! - https://devdays.kdab.com
-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 4845 bytes
Desc: not available
URL: <http://lists.qt-project.org/pipermail/development/attachments/20140403/e7405e7c/attachment.bin>


More information about the Development mailing list