public inbox for [email protected]  

help / color / mirror / Atom feed

From: Daniel Gustafsson <[email protected]>
To: Jonathan S. Katz <[email protected]>
Cc: Magnus Hagander <[email protected]>
Cc: Nils <[email protected]>
Cc: [email protected]
Subject: Re: [PATCH] Change text direction of documentation pages
Date: Mon, 29 Nov 2021 10:16:42 +0100
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>
References: <20211107163140.rnqihhpwrc5vwt2l@nixos>
	<CABUevEw+Trc7vnb=nH-_qQqQVg7qwwNsNrf_RFf6VmrqywwF8A@mail.gmail.com>
	<[email protected]>
	<[email protected]>

> On 26 Nov 2021, at 16:09, Jonathan S. Katz <[email protected]> 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/

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected], [email protected], [email protected], [email protected]
  Subject: Re: [PATCH] Change text direction of documentation pages
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox