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

> -----Original Message-----
> From: docs@lists.yoctoproject.org <docs@lists.yoctoproject.org> On Behalf
> Of Quentin Schulz
> Sent: den 11 januari 2021 13:12
> To: Quentin Schulz <foss@0leil.net>
> Cc: docs@lists.yoctoproject.org
> Subject: Re: [docs] [PATCH] documentation: sphinx-static: switchers.js:
> add release name in dropdown menu
> 
> Hi all,
> 
> Couldn't test properly on a local server so might want to keep an eye on
> it.
> 
> As usual, css or js files changes aren't picked up by sphinx so you need
> to rebuild from scratch.
> 
> When/If it gets approved, let me know so I can send backport patches.
> 
> Cheers,
> Quentin
> 
> On Mon, Jan 11, 2021 at 01:09:38PM +0100, Quentin Schulz wrote:
> > Up until now, only the version of a Yocto release was printed, which
> > isn't very user-friendly.
> >
> > Add the release name too so that it's obvious to users which release of
> > Yocto the currently open docs are applying to.
> >
> > Signed-off-by: Quentin Schulz <foss@0leil.net>
> > ---
> >  documentation/sphinx-static/switchers.js | 8 ++++----
> >  1 file changed, 4 insertions(+), 4 deletions(-)
> >
> > 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)',

> >    };
> >
> >    var all_doctypes = {
> > --
> > 2.29.2

//Peter


  reply	other threads:[~2021-01-11 17:08 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 [this message]
2021-01-12  9:19     ` Quentin Schulz

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=6ce3ef28ccb44fcb9ade563d5aabd267@XBOX03.axis.com \
    --to=peter.kjellerstedt@axis.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=foss@0leil.net \
    --cc=quentin.schulz@streamunlimited.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