Re: Update to docs root pages and navigation

From: "Jonathan S(dot) Katz" <jkatz(at)postgresql(dot)org>
To: Magnus Hagander <magnus(at)hagander(dot)net>, PostgreSQL WWW <pgsql-www(at)postgresql(dot)org>
Subject: Re: Update to docs root pages and navigation
Date: 2020-11-23 17:23:12
Message-ID: e67ea002-e74e-dab0-f0d3-78021ba04919@postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-www

On 11/23/20 11:01 AM, Magnus Hagander wrote:
> I think it requires a silly number of steps to get to our
> documentation today. It's not huge, but it's "click documentation,
> click "current manuals", click 13". And the actual /docs/ page is
> mostly empty, which makes it a waste.
>
> PFA a patch that changes this:
>
> * The /docs/ page now gets direct links to all supported documentation
> versions, including PDFs
>
> * The /docs/ page gets a big button that sends you directly to
> /docs/current/ -- that link wasn't available at all before

I would bikeshed the text on this slightly, perhaps: "Current
Documentation" or "Latest Documentation".

I'd be ok with "View Current Documentation" as well.

>
> * Translated manuals were listed both on the left and right sidebar on
> the root docs page, but not on the manuals page. Remove them from the
> left sidebar, leave them on the right one since it's now on the root
> docs page.
>
> Unrelated to the restructuring, but while at it:
> * Make the left column in the manuals table not take 50% of the width
> when all it has is a number
>
> * Add a link to the developer docs
>
> * Remove the repetitive "comprehensive manual" text (it's no more
> comprehensive than the other manual, it's just a different format),
> and insert a proper separator between the two PDF versions
>
> * Remove some redundant and incorrect template tags probably resulting
> from previous copy/paste mistakes
>
> I'm also attaching a screenshot of the main docs page with the
> changes, for those that can't easily test a website patch. (Nevermind
> the actual versions listed, as this is off a dev version of the
> database and not up to date)

I could not verify the PDF changes as I don't have them built locally at
the moment, but everything else looks fine.

+1,

Jonathan

In response to

Responses

Browse pgsql-www by date

  From Date Subject
Next Message Alvaro Herrera 2020-11-23 21:24:09 Re: Update to docs root pages and navigation
Previous Message Stephen Frost 2020-11-23 16:42:50 Re: Update to docs root pages and navigation