Opened 5 years ago

Last modified 4 years ago

#2514 new enhancement

Add cross links in generated documentation between versions of Buildbot

Reported by: rutsky Owned by:
Priority: patches-accepted Milestone: 0.9.+
Version: Keywords: docs
Cc: rutsky.vladimir@…

Description

If you try to search some documentation page in search engine you often will get results for random version of Buildbot documentation.

For example first links by query "buildbot interlocks" in Google [1] leads to 0.8.1 Buildbot documentation [2]; "buildbot CVSMaildirSource" in DuckDuckGo? [3] leads to 0.8.4p2 version [4].

It would be nice to have ability to switch to same page (or topic) of documentation for other Buildbot version (IMO, last stable release and master branch documentation required more often).

Such functionality exists in Boost [5] documentation: pages of documentation for old releases have link on the same page in latest stable release, for example here [6] at top of the page you can see link "Click here to view the latest version of this page".

This of course is actual only for published on site documentation.

[1] https://encrypted.google.com/search?q=buildbot%20interlocks

[2] http://docs.buildbot.net/0.8.1/Interlocks.html

[3] https://duckduckgo.com/?q=buildbot+CVSMaildirSource

[4] http://docs.buildbot.net/0.8.4p2/CVSMaildirSource.html

[5] http://www.boost.org

[6] http://www.boost.org/doc/libs/1_49_0/libs/geometry/doc/html/index.html

Change History (4)

comment:1 Changed 5 years ago by dustin

  • Keywords web removed
  • Milestone changed from undecided to 0.8.+

We have a sitemap in place which *should* fix this, but perhaps duckduckgo doesn't find it.

http://docs.buildbot.net/sitemap.xml

I like the idea of adding inter-version links, and perhaps a "not the current version" warning. That would probably be most easily accomplished with some post-processing of the HTML files, since all but /latest/ are static (see https://github.com/buildbot/bbdocs). That post-processing could easily be added to the other python scripts that get run at each release.

comment:2 Changed 5 years ago by rutsky

Sitemap looks correct, seems like DuckDuckGo? and Google don't treat it well (and probably many other search engines that I don't use).

I have no plans to implement this feature, just wanted to share an idea.

comment:3 Changed 4 years ago by dustin

  • Milestone changed from 0.8.+ to 0.9.+

Ticket retargeted after milestone closed

comment:4 Changed 4 years ago by sa2ajj

  • Priority changed from major to patches-accepted
Note: See TracTickets for help on using tickets.