mchristofides / pg_docs_bot

A browser extension (Firefox or Chrome) for getting to the current Postgres docs by default.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Intro

pg_docs_bot is a browser extension for getting to the current Postgres docs by default.

Benefits

When you search for Postgres related things, an old version of the documentation is often indexed. Similarly, some answers on sites like Stack Overflow link to old versions of the documentation. pg_docs_bot helps you avoid the annoyance of having to click "Current" when you get there, the frustration of having read the whole page before realising it was an old version, or even worse, not realising that it was an out of date version at all.

Fixing the root cause

Naturally, this extension doesn't help solve the root cause(s) of this issue.

There have been many conversations on the PostgreSQL mailing lists about how to teach search engines which version to link to. (June 2021 update: there is a new thread that seems promising). Please also continue to encourage people (eg on Stack Overflow or in blog posts) to link to the current version, which should gradually help.

Features of pg_docs_bot

  • Redirects links to the current version
  • After redirecting, displays a notice (including a link to the page you were redirected from)
  • Avoids redirecting some deprecated features (to avoid 404s)
  • Doesn't redirect when coming from another page in the docs, so you can still check old versions (the main problem with generic redirectors)

Limitations

  • Only supports redirecting to current (request support for other versions)
  • Works for the English language docs
  • Works for version 7.0 links upwards
  • Chrome extension works on a limited list of search engines and Stack Exchange sites (to avoid needing <all_urls> permission)

Examples

Here is an example of a search for "postgresql create index". At the time of writing, the 9.1 version of the docs is the first search result (the "current" version is 12).

Requests, issues, PRs

There are some feature ideas in the issues. Bug reports and PRs super welcome.

alt text

About

A browser extension (Firefox or Chrome) for getting to the current Postgres docs by default.

License:MIT License


Languages

Language:JavaScript 100.0%