Yocto Project Documentation
 help / color / mirror / Atom feed
From: "Quentin Schulz" <quentin.schulz@streamunlimited.com>
To: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Cc: Quentin Schulz <foss@0leil.net>,
	"docs@lists.yoctoproject.org" <docs@lists.yoctoproject.org>
Subject: Re: [docs] [PATCH] documentation: sphinx-static: switchers.js: add release name in dropdown menu
Date: Tue, 12 Jan 2021 10:19:00 +0100	[thread overview]
Message-ID: <20210112091900.ugbdh7herzosvb2d@qschulz> (raw)
In-Reply-To: <6ce3ef28ccb44fcb9ade563d5aabd267@XBOX03.axis.com>

Hi Peter,

On Mon, Jan 11, 2021 at 05:07:49PM +0000, Peter Kjellerstedt wrote:
[...]
> > On Mon, Jan 11, 2021 at 01:09:38PM +0100, Quentin Schulz wrote:
[...]
> > > diff --git a/documentation/sphinx-static/switchers.js b/documentation/sphinx-static/switchers.js
> > > index 754de2e6a..fd4dd607d 100644
> > > --- a/documentation/sphinx-static/switchers.js
> > > +++ b/documentation/sphinx-static/switchers.js
> > > @@ -3,10 +3,10 @@
> > >
> > >    var all_versions = {
> > >      'dev': 'dev (3.3)',
> > > -    '3.2.1': '3.2.1',
> > > -    '3.1.4': '3.1.4',
> > > -    '3.0.4': '3.0.4',
> > > -    '2.7.4': '2.7.4',
> > > +    '3.2.1': 'gatesgarth (3.2.1)',
> > > +    '3.1.4': 'dunfell (3.1.4)',
> > > +    '3.0.4': 'zeus (3.0.4)',
> > > +    '2.7.4': 'warrior (2.7.4)',
> 
> Since these are names, wouldn't it be more appropriate to capitalize them:
> 
>     '3.2.1': 'Gatesgarth (3.2.1)',
>     '3.1.4': 'Dunfell (3.1.4)',
>     '3.0.4': 'Zeus (3.0.4)',
>     '2.7.4': 'Warrior (2.7.4)',
> 

Yup, thanks for the review.

In the end, we'll go for a more generic approach so that bitbake and
yocto docs can both share switchers.js and use a configuration file to
fill the dropdown menu. I'll try to not forget about this review :)

We can drop this patch for now.

Cheers,
Quentin

      reply	other threads:[~2021-01-12  9:19 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-01-11 12:09 [PATCH] documentation: sphinx-static: switchers.js: add release name in dropdown menu Quentin Schulz
2021-01-11 12:11 ` [docs] " Quentin Schulz
2021-01-11 17:07   ` Peter Kjellerstedt
2021-01-12  9:19     ` Quentin Schulz [this message]

Reply instructions:

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

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

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210112091900.ugbdh7herzosvb2d@qschulz \
    --to=quentin.schulz@streamunlimited.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=foss@0leil.net \
    --cc=peter.kjellerstedt@axis.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox