From: "Paul Eggleton" <bluelightning@bluelightning.org>
To: YP docs mailing list <docs@lists.yoctoproject.org>
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>,
"Robert P. J. Day" <rpjday@crashcourse.ca>,
"Tummalapalli, Vineela" <vineela.tummalapalli@intel.com>,
Richard Purdie <richard.purdie@linuxfoundation.org>
Subject: Re: [docs] ref-manual: reverse the order of migration guides?
Date: Wed, 14 Apr 2021 12:15:32 +1200 [thread overview]
Message-ID: <4706379.0VBMTVartN@linc> (raw)
In-Reply-To: <7ff7831f-4539-8e5c-cfc6-d081651374f2@bootlin.com>
Hi Michael
On Wednesday, 14 April 2021 06:03:26 NZST Michael Opdenacker wrote:
> Wouldn't it make sense to reverse the order of migration guides in the
> reference manual
> (https://www.yoctoproject.org/docs/3.0/ref-manual/ref-manual.html#migration)
> ?
>
> I guess it would be easier to start mentioning the migration path from
> the most recent release, as version 1.3 looks ancient.
>
> Would it make sense? If so, it's easy to propose a patch...
I guess the thinking was that you would start at the point in the
documentation where you are currently at and then follow it downwards to the
current version. Whether that's the most logical I'm not sure, but if we're
changing it we should give some thought to how it will be used. People do
often go a while between upgrades, but I'll definitely agree 1.3 is much
further back than most people would need.
Robert suggests moving it out, I'm wondering if it's worth considering going a
step further and turning our release notes into a proper document, to which
this content would be added - I've often felt that the current text-only
format is a bit restrictive. That would mean there would be a separate
document per release, which is how many other software packages do it (e.g.
Django). However, I'm not sure if that would cause us too much overhead or
hassle with the other places where we currently post the release notes e.g.
announcements on the mailing list - thoughts? (For clarity I wouldn't propose
changing this until the next release.)
Cheers
Paul
next prev parent reply other threads:[~2021-04-14 0:15 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-13 18:03 ref-manual: reverse the order of migration guides? Michael Opdenacker
2021-04-13 19:40 ` [docs] " Richard Purdie
2021-04-13 19:49 ` Robert P. J. Day
2021-04-14 0:15 ` Paul Eggleton [this message]
2021-04-14 5:33 ` Nicolas Dechesne
2021-04-14 7:34 ` Michael Opdenacker
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=4706379.0VBMTVartN@linc \
--to=bluelightning@bluelightning.org \
--cc=docs@lists.yoctoproject.org \
--cc=michael.opdenacker@bootlin.com \
--cc=richard.purdie@linuxfoundation.org \
--cc=rpjday@crashcourse.ca \
--cc=vineela.tummalapalli@intel.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.