Re: [PATCH] Change text direction of documentation pages

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: "Jonathan S(dot) Katz" <jkatz(at)postgresql(dot)org>
Cc: Magnus Hagander <magnus(at)hagander(dot)net>, Nils <nils(at)nilsand(dot)re>, pgsql-www(at)lists(dot)postgresql(dot)org
Subject: Re: [PATCH] Change text direction of documentation pages
Date: 2021-11-29 09:16:42
Message-ID: B8D230AC-898D-411A-B26E-7FBCDE1A896C@yesql.se
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-www

> On 26 Nov 2021, at 16:09, Jonathan S. Katz <jkatz(at)postgresql(dot)org> wrote:
>
> On 11/26/21 9:20 AM, Daniel Gustafsson wrote:
>
>> Looking at the precedent set by other documentation sites, I think we should do
>> the simpler fix of reversing the order of elements in the title tag like the
>> (untested) below:
>> - <title>PostgreSQL: Documentation: {{page.display_version}}: {{page.title}}</title>
>> + <title>{{page.title}} &mdash; PostgreSQL {{page.display_version}} Documentation</title>
>> This will also work in all browsers and across all types of devices.
>> Shifting the order probably applies to more pages, but I agree that the docs
>> are especially interesting to tackle first.
>
> In general this is the preferred way to handle titles for web pages from a SEO perspective (though that opens up a different topic) and I've typically seen it done with a "|".

Looking at the docs pages on *.readthedocs.io, python.org, perldoc.perl.org,
rust-lang.org and php.net they all use variations of the dash, kubernetes.io
uses a pipe. I doubt that the choice of separator character (among commonly
used such separators) will play a huge role in SEO - but that being said, if I
Google "postgresql timestamp data type" the top hit is the 9.1 docs so maybe we
should just not care about SEO at all =)

> Overall OK with the approach, but would like to see how it renders.

I don't have a local pgweb setup for now, so feel free to pick it up and play
with it if you have time.

--
Daniel Gustafsson https://vmware.com/

In response to

Responses

Browse pgsql-www by date

  From Date Subject
Next Message Magnus Hagander 2021-11-30 20:04:00 Re: [PATCH] pgarchives: Allow use of IP ranges for SEARCH_CLIENTS
Previous Message Jonathan S. Katz 2021-11-26 15:09:41 Re: [PATCH] Change text direction of documentation pages