ref-manual: move release notes to separate document
A message that is not in the archive (sent off-list or not yet received): [email protected]
PATCH 1/1 ref-manual: move release notes to separate document
This makes the reference manual much lighter by moving the release notes to a separate document.
The release notes are also reordered from last to first, and they appear directly in the left bar, making them easier to find in the documentation.
---
documentation/index.rst | 1 +
documentation/ref-manual/index.rst | 1 -
documentation/ref-manual/release-process.rst | 6 ++-
.../migration.rst => release-notes/index.rst} | 48 ++++++++++---------
.../migration-1.3.rst | 4 +-
.../migration-1.4.rst | 6 +--
.../migration-1.5.rst | 4 +-
.../migration-1.6.rst | 4 +-
.../migration-1.7.rst | 4 +-
.../migration-1.8.rst | 4 +-
.../migration-2.0.rst | 4 +-
.../migration-2.1.rst | 6 +--
.../migration-2.2.rst | 8 ++--
.../migration-2.3.rst | 4 +-
.../migration-2.4.rst | 4 +-
.../migration-2.5.rst | 4 +-
.../migration-2.6.rst | 6 +--
.../migration-2.7.rst | 4 +-
.../migration-3.0.rst | 4 +-
.../migration-3.1.rst | 4 +-
.../migration-3.2.rst | 4 +-
.../migration-3.3.rst | 4 +-
.../migration-general.rst | 0
23 files changed, 71 insertions(+), 67 deletions(-)
rename documentation/{ref-manual/migration.rst => release-notes/index.rst} (56%)
rename documentation/{ref-manual => release-notes}/migration-1.3.rst (98%)
rename documentation/{ref-manual => release-notes}/migration-1.4.rst (98%)
rename documentation/{ref-manual => release-notes}/migration-1.5.rst (99%)
rename documentation/{ref-manual => release-notes}/migration-1.6.rst (99%)
rename documentation/{ref-manual => release-notes}/migration-1.7.rst (98%)
rename documentation/{ref-manual => release-notes}/migration-1.8.rst (98%)
rename documentation/{ref-manual => release-notes}/migration-2.0.rst (98%)
rename documentation/{ref-manual => release-notes}/migration-2.1.rst (99%)
rename documentation/{ref-manual => release-notes}/migration-2.2.rst (98%)
rename documentation/{ref-manual => release-notes}/migration-2.3.rst (99%)
rename documentation/{ref-manual => release-notes}/migration-2.4.rst (99%)
rename documentation/{ref-manual => release-notes}/migration-2.5.rst (99%)
rename documentation/{ref-manual => release-notes}/migration-2.6.rst (99%)
rename documentation/{ref-manual => release-notes}/migration-2.7.rst (98%)
rename documentation/{ref-manual => release-notes}/migration-3.0.rst (99%)
rename documentation/{ref-manual => release-notes}/migration-3.1.rst (98%)
rename documentation/{ref-manual => release-notes}/migration-3.2.rst (99%)
rename documentation/{ref-manual => release-notes}/migration-3.3.rst (98%)
rename documentation/{ref-manual => release-notes}/migration-general.rst (100%)documentation/index.rst +1 -0
@@ -41,6 +41,7 @@ Welcome to the Yocto Project Documentation :caption: Releases manual :hidden: + Release Notes <release-notes/index> releases .. toctree::
documentation/ref-manual/index.rst +0 -1
@@ -13,7 +13,6 @@ Yocto Project Reference Manual system-requirements terms release-process - migration structure classes tasks
documentation/ref-manual/release-process.rst +4 -2
@@ -62,8 +62,10 @@ codename are likely to be compatible and thus work together. Releases are given a nominal release version as well but the codename is used in repositories for this reason. You can find information on Yocto -Project releases and codenames at -:yocto_wiki:`/Releases`. +Project releases and codenames at :yocto_wiki:`/Releases`. + +Our :doc:`/release-notes/index` detail how to migrate from one release of +the Yocto Project to the next. Stable Release Process ======================
documentation/release-notes/index.rst renamed from documentation/ref-manual/migration.rst +25 -23
57 lines not on this page · raw message
documentation/release-notes/migration-1.3.rst renamed from documentation/ref-manual/migration-1.3.rst +2 -2
@@ -1,7 +1,7 @@ .. SPDX-License-Identifier: CC-BY-SA-2.0-UK -Moving to the Yocto Project 1.3 Release (danny) -=============================================== +Release 1.3 (danny) +=================== This section provides migration information for moving to the Yocto Project 1.3 Release (codename "danny") from the prior release.
documentation/release-notes/migration-1.4.rst renamed from documentation/ref-manual/migration-1.4.rst +3 -3
@@ -1,5 +1,5 @@ -Moving to the Yocto Project 1.4 Release (dylan) -=============================================== +Release 1.4 (dylan) +=================== This section provides migration information for moving to the Yocto Project 1.4 Release (codename "dylan") from the prior release.
@@ -60,7 +60,7 @@ Differences include the following: the :term:`MACHINEOVERRIDES` or :term:`DISTROOVERRIDES` variables, as appropriate. For more related changes, see the - ":ref:`ref-manual/migration-1.4:variables`" section. + ":ref:`release-notes/migration-1.4:variables`" section. .. _migration-1.4-proxies-and-fetching-source:
documentation/release-notes/migration-1.5.rst renamed from documentation/ref-manual/migration-1.5.rst +2 -2
@@ -1,5 +1,5 @@ -Moving to the Yocto Project 1.5 Release (dora) -============================================== +Release 1.5 (dora) +================== This section provides migration information for moving to the Yocto Project 1.5 Release (codename "dora") from the prior release.
documentation/release-notes/migration-1.6.rst renamed from documentation/ref-manual/migration-1.6.rst +2 -2
@@ -1,5 +1,5 @@ -Moving to the Yocto Project 1.6 Release (daisy) -=============================================== +Release 1.6 (daisy) +=================== This section provides migration information for moving to the Yocto Project 1.6 Release (codename "daisy") from the prior release.
documentation/release-notes/migration-1.7.rst renamed from documentation/ref-manual/migration-1.7.rst +2 -2
@@ -1,5 +1,5 @@ -Moving to the Yocto Project 1.7 Release (dizzy) -=============================================== +Release 1.7 (dizzy) +=================== This section provides migration information for moving to the Yocto Project 1.7 Release (codename "dizzy") from the prior release.
documentation/release-notes/migration-1.8.rst renamed from documentation/ref-manual/migration-1.8.rst +2 -2
@@ -1,5 +1,5 @@ -Moving to the Yocto Project 1.8 Release (fido) -============================================== +Release 1.8 (fido) +================== This section provides migration information for moving to the Yocto Project 1.8 Release (codename "fido") from the prior release.
documentation/release-notes/migration-2.0.rst renamed from documentation/ref-manual/migration-2.0.rst +2 -2
@@ -1,5 +1,5 @@ -Moving to the Yocto Project 2.0 Release (jethro) -================================================ +Release 2.0 (jethro) +==================== This section provides migration information for moving to the Yocto Project 2.0 Release (codename "jethro") from the prior release.
documentation/release-notes/migration-2.1.rst renamed from documentation/ref-manual/migration-2.1.rst +3 -3
@@ -1,5 +1,5 @@ -Moving to the Yocto Project 2.1 Release (krogoth) -================================================= +Release 2.1 (krogoth) +===================== This section provides migration information for moving to the Yocto Project 2.1 Release (codename "krogoth") from the prior release.
@@ -179,7 +179,7 @@ The following recipes have been removed in the 2.1 release: - ``python-pygtk``: Recipe became obsolete. - ``adt-installer``: Recipe became obsolete. See the - ":ref:`ref-manual/migration-2.1:adt removed`" section for more information. + ":ref:`release-notes/migration-2.1:adt removed`" section for more information. .. _migration-2.1-class-changes:
documentation/release-notes/migration-2.2.rst renamed from documentation/ref-manual/migration-2.2.rst +4 -4
@@ -1,5 +1,5 @@ -Moving to the Yocto Project 2.2 Release (morty) -=============================================== +Release 2.2 (morty) +=================== This section provides migration information for moving to the Yocto Project 2.2 Release (codename "morty") from the prior release.
@@ -364,7 +364,7 @@ The following recipes have been removed: - ``sato-icon-theme``: Became obsolete. - ``swabber-native``: Swabber has been removed. See the :ref:`entry on - Swabber <ref-manual/migration-2.2:swabber has been removed>`. + Swabber <release-notes/migration-2.2:swabber has been removed>`. - ``tslib``: No longer needed and has been moved to ``meta-oe``.
@@ -390,7 +390,7 @@ The following classes have been removed: - ``sip``: Mostly unused. - ``swabber``: See the :ref:`entry on - Swabber <ref-manual/migration-2.2:swabber has been removed>`. + Swabber <release-notes/migration-2.2:swabber has been removed>`. .. _migration-2.2-minor-packaging-changes:
documentation/release-notes/migration-2.3.rst renamed from documentation/ref-manual/migration-2.3.rst +2 -2
@@ -1,5 +1,5 @@ -Moving to the Yocto Project 2.3 Release (pyro) -============================================== +Release 2.3 (pyro) +================== This section provides migration information for moving to the Yocto Project 2.3 Release (codename "pyro") from the prior release.
documentation/release-notes/migration-2.4.rst renamed from documentation/ref-manual/migration-2.4.rst +2 -2
@@ -1,5 +1,5 @@ -Moving to the Yocto Project 2.4 Release (rocko) -=============================================== +Release 2.4 (rocko) +=================== This section provides migration information for moving to the Yocto Project 2.4 Release (codename "rocko") from the prior release.
documentation/release-notes/migration-2.5.rst renamed from documentation/ref-manual/migration-2.5.rst +2 -2
@@ -1,5 +1,5 @@ -Moving to the Yocto Project 2.5 Release (sumo) -============================================== +Release 2.5 (sumo) +================== This section provides migration information for moving to the Yocto Project 2.5 Release (codename "sumo") from the prior release.
documentation/release-notes/migration-2.6.rst renamed from documentation/ref-manual/migration-2.6.rst +3 -3
@@ -1,5 +1,5 @@ -Moving to the Yocto Project 2.6 Release (thud) -============================================== +Release 2.6 (thud) +================== This section provides migration information for moving to the Yocto Project 2.6 Release (codename "thud") from the prior release.
@@ -110,7 +110,7 @@ upon the older ``*proto`` recipes need to be changed to depend on the newer ``xorgproto`` recipe instead. For names of recipes removed because of this repository change, see the -:ref:`ref-manual/migration-2.6:removed recipes` section. +:ref:`release-notes/migration-2.6:removed recipes` section. .. _migration-2.6-distutils-distutils3-fetching-dependencies:
documentation/release-notes/migration-2.7.rst renamed from documentation/ref-manual/migration-2.7.rst +2 -2
@@ -1,5 +1,5 @@ -Moving to the Yocto Project 2.7 Release (warrior) -================================================= +Release 2.7 (warrior) +===================== This section provides migration information for moving to the Yocto Project 2.7 Release (codename "warrior") from the prior release.
documentation/release-notes/migration-3.0.rst renamed from documentation/ref-manual/migration-3.0.rst +2 -2
@@ -1,5 +1,5 @@ -Moving to the Yocto Project 3.0 Release (zeus) -============================================== +Release 3.0 (zeus) +================== This section provides migration information for moving to the Yocto Project 3.0 Release (codename "zeus") from the prior release.
documentation/release-notes/migration-3.1.rst renamed from documentation/ref-manual/migration-3.1.rst +2 -2
@@ -1,5 +1,5 @@ -Moving to the Yocto Project 3.1 Release (dunfell) -================================================= +Release 3.1 (dunfell) +===================== This section provides migration information for moving to the Yocto Project 3.1 Release (codename "dunfell") from the prior release.
documentation/release-notes/migration-3.2.rst renamed from documentation/ref-manual/migration-3.2.rst +2 -2
@@ -1,5 +1,5 @@ -Moving to the Yocto Project 3.2 Release (gatesgarth) -==================================================== +Release 3.2 (gatesgarth) +======================== This section provides migration information for moving to the Yocto Project 3.2 Release (codename "gatesgarth") from the prior release.
documentation/release-notes/migration-3.3.rst renamed from documentation/ref-manual/migration-3.3.rst +2 -2
@@ -1,5 +1,5 @@ -Moving to the Yocto Project 3.3 Release (hardknott) -=================================================== +Release 3.3 (hardknott) +======================= This section provides migration information for moving to the Yocto Project 3.3 Release (codename "hardknott") from the prior release.
documentation/release-notes/migration-general.rst renamed from documentation/ref-manual/migration-general.rst +0 -0
Signature · 1 line
2.25.1
A message that is not in the archive (sent off-list or not yet received): [email protected]
Greetings,
Quoted 6 lines · Michael Opdenacker
This makes the reference manual much lighter by moving the release notes to a separate document.
The release notes are also reordered from last to first, and they appear directly in the left bar, making them easier to find in the documentation.
These are my proposed changes, trying to match what was discussed back in April.
Don't hesitate to try them by applying them to the "master" branch and running "make html". In particular, you should see a new "Release Notes" entry in the left column.
Your feedback and reviews are welcome. I don't expect to get it right the first time :)
Thanks in advance,
Michael.
Signature · 3 lines
Michael Opdenacker, Bootlin Embedded Linux and Kernel engineering https://bootlin.com
Can you please push to master-next , so that everyone can see what it looks like without having to rebuild (e.g. http://docs.yoctoproject.org/next/
will be updated after you push)?
e.g. i am cc'ding Vineela (release manager) , so that she gets a chance to review.
Quoted 35 lines · Michael Opdenacker
Greetings,
Quoted 6 lines · Michael Opdenacker
This makes the reference manual much lighter by moving the release notes to a separate document.
The release notes are also reordered from last to first, and they appear directly in the left bar, making them easier to find in the documentation.
These are my proposed changes, trying to match what was discussed back in April.
Don't hesitate to try them by applying them to the "master" branch and running "make html". In particular, you should see a new "Release Notes" entry in the left column.
Your feedback and reviews are welcome. I don't expect to get it right the first time :)
Thanks in advance,
Michael.
--
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
Hi Nicolas,
Quoted 7 lines · Nicolas Dechesne
Can you please push to master-next , so that everyone can see what it looks like without having to rebuild
(e.g. http://docs.yoctoproject.org/next/
<http://docs.yoctoproject.org/next/> will be updated after you push)?e.g. i am cc'ding Vineela (release manager) , so that she gets a chance to review.
Done. I couldn't find this URL any more, so I wasn't sure that the functionality existed.
Thanks in advance for the reviews,
Cheers,
Michael.
Signature · 3 lines
Michael Opdenacker, Bootlin Embedded Linux and Kernel engineering https://bootlin.com
A message that is not in the archive (sent off-list or not yet received): [email protected]
Hello,
Quoted 8 lines · Michael Opdenacker
Hi Nicolas,
Quoted 5 lines · Nicolas Dechesne
Can you please push to master-next , so that everyone can see what it looks like without having to rebuild
(e.g. http://docs.yoctoproject.org/next/
<http://docs.yoctoproject.org/next/> will be updated after you push)?
Quoted 7 lines
Quoted 2 lines
e.g. i am cc'ding Vineela (release manager) , so that she gets a chance to review.
Done. I couldn't find this URL any more, so I wasn't sure that the functionality existed.
Thanks in advance for the reviews,
With these changes visible on http://docs.yoctoproject.org/next/, the location of the release notes is changing. How much would this break other resources, such as links on our website? I remember Paul's warning 5 days before Hardknott was released, but I hope we are now far enough from the next release.
Another question is whether "Release notes" is the right title for these migration guides, at least in the left menu. Shouldn't we just call them "Release migration guides" as they truly are, knowing that the true release notes are on
https://www.yoctoproject.org/software-overview/downloads/?
Cheers,
Michael.
Signature · 3 lines
Michael Opdenacker, Bootlin Embedded Linux and Kernel engineering https://bootlin.com
Quoted 26 lines · Michael Opdenacker
Hello,
Quoted 8 lines · Michael Opdenacker
Hi Nicolas,
Quoted 5 lines · Nicolas Dechesne
Can you please push to master-next , so that everyone can see what it looks like without having to rebuild
(e.g. http://docs.yoctoproject.org/next/
<http://docs.yoctoproject.org/next/> will be updated after you push)?Quoted 7 lines
Quoted 2 lines
e.g. i am cc'ding Vineela (release manager) , so that she gets a chance to review.
Done. I couldn't find this URL any more, so I wasn't sure that the functionality existed.
Thanks in advance for the reviews,
With these changes visible on http://docs.yoctoproject.org/next/, the location of the release notes is changing. How much would this break other resources, such as links on our website? I remember Paul's warning 5 days before Hardknott was released, but I hope we are now far enough from the next release.
Quoted 5 lines
Another question is whether "Release notes" is the right title for these migration guides, at least in the left menu. Shouldn't we just call them "Release migration guides" as they truly are, knowing that the true release notes are on
https://www.yoctoproject.org/software-overview/downloads/?
Yes, they're migration guides, the release notes are something different.
Cheers,
Richard
Quoted 28 lines · Richard Purdie
Quoted 10 lines · Michael Opdenacker
Hello,
Quoted 7 lines · Michael Opdenacker
Hi Nicolas,
Quoted 4 lines · Nicolas Dechesne
Can you please push to master-next , so that everyone can see what it looks like without having to rebuild
(e.g. http://docs.yoctoproject.org/next/
<http://docs.yoctoproject.org/next/> will be updated after youpush)?
Quoted 16 lines
Quoted 8 lines
Quoted 3 lines
e.g. i am cc'ding Vineela (release manager) , so that she gets a chance to review.
Done. I couldn't find this URL any more, so I wasn't sure that the functionality existed.
Thanks in advance for the reviews,
With these changes visible on http://docs.yoctoproject.org/next/, the location of the release notes is changing. How much would this break other resources, such as links on our website? I remember Paul's warning 5 days before Hardknott was released, but I hope we are now far enough from the next release.
Quoted 8 lines
Quoted 5 lines
Another question is whether "Release notes" is the right title for these migration guides, at least in the left menu. Shouldn't we just call them "Release migration guides" as they truly are, knowing that the true release notes are on
https://www.yoctoproject.org/software-overview/downloads/?Yes, they're migration guides, the release notes are something different.
Side question.. should we move the release notes into the docs website? now that it's based on Sphinx, it looks like it would be well suited..
Quoted 6 lines
Cheers,
Richard
Nicolas, Richard,
Quoted 4 lines · Nicolas Dechesne
Side question.. should we move the release notes into the docs website? now that it's based on Sphinx, it looks like it would be well suited..
Interesting idea, to get a much better looking output. This way we could have hyperlinks, typically to each commit.
Anyway, that's a generated file, right? What would be the workflow? Generate the release-notes-<version>.rst file and manually add it to the yocto-docs directory, even though that's a generated file? What's the script generating the current release notes, so that I can prepare a version generating .rst instead?
Cheers,
Michael.
Signature · 3 lines
Michael Opdenacker, Bootlin Embedded Linux and Kernel engineering https://bootlin.com
Hi Richard,
Quoted 7 lines · Richard Purdie
Quoted 6 lines
Another question is whether "Release notes" is the right title for these migration guides, at least in the left menu. Shouldn't we just call them "Release migration guides" as they truly are, knowing that the true release notes are on
https://www.yoctoproject.org/software-overview/downloads/?Yes, they're migration guides, the release notes are something different.
Right, thanks for confirming.
I updated my branch and you can see the result on
http://docs.yoctoproject.org/next/
Cheers,
Michael.
Signature · 3 lines
Michael Opdenacker, Bootlin Embedded Linux and Kernel engineering https://bootlin.com
Hi Michael,
Quoted 9 lines · Michael Opdenacker
Hi Richard,
Quoted 6 lines · Richard Purdie
Quoted 6 lines
Another question is whether "Release notes" is the right title for these migration guides, at least in the left menu. Shouldn't we just call them "Release migration guides" as they truly are, knowing that the true release notes are on
https://www.yoctoproject.org/software-overview/downloads/?
Quoted 7 lines
Quoted 1 line
Yes, they're migration guides, the release notes are something different.
Right, thanks for confirming.
I updated my branch and you can see the result on
http://docs.yoctoproject.org/next/
I can't. I only have a fileserver webpage on which I can click on ../ which redirects me to http://docs.yoctoproject.org/
Cheers,
Quentin
HI Quentin,
Quoted 2 lines · Quentin Schulz
I can't. I only have a fileserver webpage on which I can click on ../ which redirects me to http://docs.yoctoproject.org/
Oops, maybe because my "master-next" branch was broken until 15 minutes ago. This is fixed now but the autobuilder may need time to update the contents.
Thanks for the notification.
Cheers,
Michael.
Signature · 3 lines
Michael Opdenacker, Bootlin Embedded Linux and Kernel engineering https://bootlin.com
A message that is not in the archive (sent off-list or not yet received): [email protected]
Hi Quentin,
Quoted 10 lines · Michael Opdenacker
HI Quentin,
Quoted 2 lines · Quentin Schulz
I can't. I only have a fileserver webpage on which I can click on ../ which redirects me to http://docs.yoctoproject.org/
Oops, maybe because my "master-next" branch was broken until 15 minutes ago. This is fixed now but the autobuilder may need time to update the contents.
Thanks for the notification.
That's fixed now if you're interested in having a look:
https://docs.yoctoproject.org/next/
I guess pushing one update wasn't enough, but that's fixed since the two new commits that I've just merged.
Cheers,
Michael.
Signature · 3 lines
Michael Opdenacker, Bootlin Embedded Linux and Kernel engineering https://bootlin.com
Hi Michael,
Quoted 12 lines · Michael Opdenacker
Hi Quentin,
Quoted 9 lines · Michael Opdenacker
HI Quentin,
Quoted 2 lines · Quentin Schulz
I can't. I only have a fileserver webpage on which I can click on ../ which redirects me to http://docs.yoctoproject.org/
Oops, maybe because my "master-next" branch was broken until 15 minutes ago. This is fixed now but the autobuilder may need time to update the contents.
Quoted 5 lines
Quoted 1 line
Thanks for the notification.
That's fixed now if you're interested in having a look:
https://docs.yoctoproject.org/next/
I was about to say that it finally works now, it didn't over the week-end.
Thanks for the update!
I was wondering if it made more sense to pick more expressive words for "current" and "previous" release manuals. Something like maintained/unmaintained for example? Or... EOL/outdated for the second kind?
Also, I would move the release number after the release name, because it's the place where you usually have section number in e.g. Reference Manual in the navigation panel.
In any case, looks already great to me!
Thanks Michael!
Cheers,
Quentin
Hi Quentin,
Quoted 4 lines · Quentin Schulz
I was wondering if it made more sense to pick more expressive words for "current" and "previous" release manuals. Something like maintained/unmaintained for example? Or... EOL/outdated for the second kind?
Very idea. It always sounded strange to me. I could propose "maintained" (or supported?) and "outdated" (which is shorter than "unmaintained" for use in the left menu).
Quoted 4 lines
Also, I would move the release number after the release name, because it's the place where you usually have section number in e.g. Reference Manual in the navigation panel.
Indeed, for the same reason, I had to prefix the title of migration guides by "Release" to avoid this confusion.
A benefit of doing this is that we would be more consistent withe the way the migration guides are listed.
I'll submit the two changes that you proposed.
Thanks again :-)
Michael.
Signature · 3 lines
Michael Opdenacker, Bootlin Embedded Linux and Kernel engineering https://bootlin.com