* [PATCH] manuals: delete unmaintained history sections
@ 2021-09-14 14:59 Michael Opdenacker
2021-09-15 10:59 ` [docs] " Quentin Schulz
0 siblings, 1 reply; 6+ messages in thread
From: Michael Opdenacker @ 2021-09-14 14:59 UTC (permalink / raw)
To: docs; +Cc: Michael Opdenacker
This deletes the history sections in each sub-manual,
which didn't add any value, given that they didn't list
the changes from one Yocto Project version to the next.
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/bsp-guide/history.rst | 73 ----------------------
documentation/bsp-guide/index.rst | 1 -
documentation/dev-manual/history.rst | 67 --------------------
documentation/dev-manual/index.rst | 1 -
documentation/kernel-dev/history.rst | 58 ------------------
documentation/kernel-dev/index.rst | 1 -
documentation/overview-manual/history.rst | 28 ---------
documentation/overview-manual/index.rst | 1 -
documentation/profile-manual/history.rst | 58 ------------------
documentation/profile-manual/index.rst | 1 -
documentation/ref-manual/history.rst | 74 -----------------------
documentation/ref-manual/index.rst | 1 -
documentation/sdk-manual/history.rst | 40 ------------
documentation/sdk-manual/index.rst | 1 -
documentation/test-manual/history.rst | 16 -----
documentation/test-manual/index.rst | 1 -
documentation/toaster-manual/history.rst | 46 --------------
documentation/toaster-manual/index.rst | 1 -
18 files changed, 469 deletions(-)
delete mode 100644 documentation/bsp-guide/history.rst
delete mode 100644 documentation/dev-manual/history.rst
delete mode 100644 documentation/kernel-dev/history.rst
delete mode 100644 documentation/overview-manual/history.rst
delete mode 100644 documentation/profile-manual/history.rst
delete mode 100644 documentation/ref-manual/history.rst
delete mode 100644 documentation/sdk-manual/history.rst
delete mode 100644 documentation/test-manual/history.rst
delete mode 100644 documentation/toaster-manual/history.rst
diff --git a/documentation/bsp-guide/history.rst b/documentation/bsp-guide/history.rst
deleted file mode 100644
index d7cd8ef7f0..0000000000
--- a/documentation/bsp-guide/history.rst
+++ /dev/null
@@ -1,73 +0,0 @@
-.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
-
-***********************
-Manual Revision History
-***********************
-
-.. list-table::
- :widths: 10 15 40
- :header-rows: 1
-
- * - Revision
- - Date
- - Note
- * - 0.9
- - November 2010
- - The initial document released with the Yocto Project 0.9 Release
- * - 1.0
- - April 2011
- - Released with the Yocto Project 1.0 Release.
- * - 1.1
- - October 2011
- - Released with the Yocto Project 1.1 Release.
- * - 1.2
- - April 2012
- - Released with the Yocto Project 1.2 Release.
- * - 1.3
- - October 2012
- - Released with the Yocto Project 1.3 Release.
- * - 1.4
- - April 2013
- - Released with the Yocto Project 1.4 Release.
- * - 1.5
- - October 2013
- - Released with the Yocto Project 1.5 Release.
- * - 1.6
- - April 2014
- - Released with the Yocto Project 1.6 Release.
- * - 1.7
- - October 2014
- - Released with the Yocto Project 1.7 Release.
- * - 1.8
- - April 2015
- - Released with the Yocto Project 1.8 Release.
- * - 2.0
- - October 2015
- - Released with the Yocto Project 2.0 Release.
- * - 2.1
- - April 2016
- - Released with the Yocto Project 2.1 Release.
- * - 2.2
- - October 2016
- - Released with the Yocto Project 2.2 Release.
- * - 2.3
- - May 2017
- - Released with the Yocto Project 2.3 Release.
- * - 2.4
- - October 2017
- - Released with the Yocto Project 2.4 Release.
- * - 2.5
- - May 2018
- - Released with the Yocto Project 2.5 Release.
- * - 2.6
- - November 2018
- - Released with the Yocto Project 2.6 Release.
- * - 2.7
- - May 2019
- - Released with the Yocto Project 2.7 Release.
- * - 3.0
- - October 2019
- - Released with the Yocto Project 3.0 Release.
- * - 3.1
- - April 2020
- - Released with the Yocto Project 3.1 Release.
diff --git a/documentation/bsp-guide/index.rst b/documentation/bsp-guide/index.rst
index a4394a85ed..9a8e034ae6 100644
--- a/documentation/bsp-guide/index.rst
+++ b/documentation/bsp-guide/index.rst
@@ -11,6 +11,5 @@ Yocto Project Board Support Package Developer's Guide
:numbered:
bsp
- history
.. include:: /boilerplate.rst
diff --git a/documentation/dev-manual/history.rst b/documentation/dev-manual/history.rst
deleted file mode 100644
index 1ba312422c..0000000000
--- a/documentation/dev-manual/history.rst
+++ /dev/null
@@ -1,67 +0,0 @@
-.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
-
-***********************
-Manual Revision History
-***********************
-
-.. list-table::
- :widths: 10 15 40
- :header-rows: 1
-
- * - Revision
- - Date
- - Note
- * - 1.1
- - October 2011
- - The initial document released with the Yocto Project 1.1 Release
- * - 1.2
- - April 2012
- - Released with the Yocto Project 1.2 Release.
- * - 1.3
- - October 2012
- - Released with the Yocto Project 1.3 Release.
- * - 1.4
- - April 2013
- - Released with the Yocto Project 1.4 Release.
- * - 1.5
- - October 2013
- - Released with the Yocto Project 1.5 Release.
- * - 1.6
- - April 2014
- - Released with the Yocto Project 1.6 Release.
- * - 1.7
- - October 2014
- - Released with the Yocto Project 1.7 Release.
- * - 1.8
- - April 2015
- - Released with the Yocto Project 1.8 Release.
- * - 2.0
- - October 2015
- - Released with the Yocto Project 2.0 Release.
- * - 2.1
- - April 2016
- - Released with the Yocto Project 2.1 Release.
- * - 2.2
- - October 2016
- - Released with the Yocto Project 2.2 Release.
- * - 2.3
- - May 2017
- - Released with the Yocto Project 2.3 Release.
- * - 2.4
- - October 2017
- - Released with the Yocto Project 2.4 Release.
- * - 2.5
- - May 2018
- - Released with the Yocto Project 2.5 Release.
- * - 2.6
- - November 2018
- - Released with the Yocto Project 2.6 Release.
- * - 2.7
- - May 2019
- - Released with the Yocto Project 2.7 Release.
- * - 3.0
- - October 2019
- - Released with the Yocto Project 3.0 Release.
- * - 3.1
- - April 2020
- - Released with the Yocto Project 3.1 Release.
diff --git a/documentation/dev-manual/index.rst b/documentation/dev-manual/index.rst
index 941db2df8c..f16b135c4d 100644
--- a/documentation/dev-manual/index.rst
+++ b/documentation/dev-manual/index.rst
@@ -14,6 +14,5 @@ Yocto Project Development Tasks Manual
start
common-tasks
qemu
- history
.. include:: /boilerplate.rst
diff --git a/documentation/kernel-dev/history.rst b/documentation/kernel-dev/history.rst
deleted file mode 100644
index 761b506aca..0000000000
--- a/documentation/kernel-dev/history.rst
+++ /dev/null
@@ -1,58 +0,0 @@
-.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
-
-***********************
-Manual Revision History
-***********************
-
-.. list-table::
- :widths: 10 15 40
- :header-rows: 1
-
- * - Revision
- - Date
- - Note
- * - 1.4
- - April 2013
- - The initial document released with the Yocto Project 1.4 Release
- * - 1.5
- - October 2013
- - Released with the Yocto Project 1.5 Release.
- * - 1.6
- - April 2014
- - Released with the Yocto Project 1.6 Release.
- * - 1.7
- - October 2014
- - Released with the Yocto Project 1.7 Release.
- * - 1.8
- - April 2015
- - Released with the Yocto Project 1.8 Release.
- * - 2.0
- - October 2015
- - Released with the Yocto Project 2.0 Release.
- * - 2.1
- - April 2016
- - Released with the Yocto Project 2.1 Release.
- * - 2.2
- - October 2016
- - Released with the Yocto Project 2.2 Release.
- * - 2.3
- - May 2017
- - Released with the Yocto Project 2.3 Release.
- * - 2.4
- - October 2017
- - Released with the Yocto Project 2.4 Release.
- * - 2.5
- - May 2018
- - Released with the Yocto Project 2.5 Release.
- * - 2.6
- - November 2018
- - Released with the Yocto Project 2.6 Release.
- * - 2.7
- - May 2019
- - Released with the Yocto Project 2.7 Release.
- * - 3.0
- - October 2019
- - Released with the Yocto Project 3.0 Release.
- * - 3.1
- - April 2020
- - Released with the Yocto Project 3.1 Release.
diff --git a/documentation/kernel-dev/index.rst b/documentation/kernel-dev/index.rst
index a8848ec8cc..bd20e371e0 100644
--- a/documentation/kernel-dev/index.rst
+++ b/documentation/kernel-dev/index.rst
@@ -16,6 +16,5 @@ Yocto Project Linux Kernel Development Manual
concepts-appx
maint-appx
faq
- history
.. include:: /boilerplate.rst
diff --git a/documentation/overview-manual/history.rst b/documentation/overview-manual/history.rst
deleted file mode 100644
index 6fc700a013..0000000000
--- a/documentation/overview-manual/history.rst
+++ /dev/null
@@ -1,28 +0,0 @@
-.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
-
-***********************
-Manual Revision History
-***********************
-
-.. list-table::
- :widths: 10 15 40
- :header-rows: 1
-
- * - Revision
- - Date
- - Note
- * - 2.5
- - May 2018
- - The initial document released with the Yocto Project 2.5 Release
- * - 2.6
- - November 2018
- - Released with the Yocto Project 2.6 Release.
- * - 2.7
- - May 2019
- - Released with the Yocto Project 2.7 Release.
- * - 3.0
- - October 2019
- - Released with the Yocto Project 3.0 Release.
- * - 3.1
- - April 2020
- - Released with the Yocto Project 3.1 Release.
diff --git a/documentation/overview-manual/index.rst b/documentation/overview-manual/index.rst
index 123aed9b8b..04061f8f4e 100644
--- a/documentation/overview-manual/index.rst
+++ b/documentation/overview-manual/index.rst
@@ -14,6 +14,5 @@ Yocto Project Overview and Concepts Manual
yp-intro
development-environment
concepts
- history
.. include:: /boilerplate.rst
diff --git a/documentation/profile-manual/history.rst b/documentation/profile-manual/history.rst
deleted file mode 100644
index 761b506aca..0000000000
--- a/documentation/profile-manual/history.rst
+++ /dev/null
@@ -1,58 +0,0 @@
-.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
-
-***********************
-Manual Revision History
-***********************
-
-.. list-table::
- :widths: 10 15 40
- :header-rows: 1
-
- * - Revision
- - Date
- - Note
- * - 1.4
- - April 2013
- - The initial document released with the Yocto Project 1.4 Release
- * - 1.5
- - October 2013
- - Released with the Yocto Project 1.5 Release.
- * - 1.6
- - April 2014
- - Released with the Yocto Project 1.6 Release.
- * - 1.7
- - October 2014
- - Released with the Yocto Project 1.7 Release.
- * - 1.8
- - April 2015
- - Released with the Yocto Project 1.8 Release.
- * - 2.0
- - October 2015
- - Released with the Yocto Project 2.0 Release.
- * - 2.1
- - April 2016
- - Released with the Yocto Project 2.1 Release.
- * - 2.2
- - October 2016
- - Released with the Yocto Project 2.2 Release.
- * - 2.3
- - May 2017
- - Released with the Yocto Project 2.3 Release.
- * - 2.4
- - October 2017
- - Released with the Yocto Project 2.4 Release.
- * - 2.5
- - May 2018
- - Released with the Yocto Project 2.5 Release.
- * - 2.6
- - November 2018
- - Released with the Yocto Project 2.6 Release.
- * - 2.7
- - May 2019
- - Released with the Yocto Project 2.7 Release.
- * - 3.0
- - October 2019
- - Released with the Yocto Project 3.0 Release.
- * - 3.1
- - April 2020
- - Released with the Yocto Project 3.1 Release.
diff --git a/documentation/profile-manual/index.rst b/documentation/profile-manual/index.rst
index 6e54133e0a..0270932ca0 100644
--- a/documentation/profile-manual/index.rst
+++ b/documentation/profile-manual/index.rst
@@ -14,6 +14,5 @@ Yocto Project Profiling and Tracing Manual
arch
usage
examples
- history
.. include:: /boilerplate.rst
diff --git a/documentation/ref-manual/history.rst b/documentation/ref-manual/history.rst
deleted file mode 100644
index dc0a2ae797..0000000000
--- a/documentation/ref-manual/history.rst
+++ /dev/null
@@ -1,74 +0,0 @@
-.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
-
-***********************
-Manual Revision History
-***********************
-
-.. list-table::
- :widths: 10 15 40
- :header-rows: 1
-
- * - Revision
- - Date
- - Note
- * - 0.9
- - November 2010
- - The initial document released with the Yocto Project 0.9 Release
- * - 1.0
- - April 2011
- - Released with the Yocto Project 1.0 Release.
- * - 1.1
- - October 2011
- - Released with the Yocto Project 1.1 Release.
- * - 1.2
- - April 2012
- - Released with the Yocto Project 1.2 Release.
- * - 1.3
- - October 2012
- - Released with the Yocto Project 1.3 Release.
- * - 1.4
- - April 2013
- - Released with the Yocto Project 1.4 Release.
- * - 1.5
- - October 2013
- - Released with the Yocto Project 1.5 Release.
- * - 1.6
- - April 2014
- - Released with the Yocto Project 1.6 Release.
- * - 1.7
- - October 2014
- - Released with the Yocto Project 1.7 Release.
- * - 1.8
- - April 2015
- - Released with the Yocto Project 1.8 Release.
- * - 2.0
- - October 2015
- - Released with the Yocto Project 2.0 Release.
- * - 2.1
- - April 2016
- - Released with the Yocto Project 2.1 Release.
- * - 2.2
- - October 2016
- - Released with the Yocto Project 2.2 Release.
- * - 2.3
- - May 2017
- - Released with the Yocto Project 2.3 Release.
- * - 2.4
- - October 2017
- - Released with the Yocto Project 2.4 Release.
- * - 2.5
- - May 2018
- - Released with the Yocto Project 2.5 Release.
- * - 2.6
- - November 2018
- - Released with the Yocto Project 2.6 Release.
- * - 2.7
- - May 2019
- - Released with the Yocto Project 2.7 Release.
- * - 3.0
- - October 2019
- - Released with the Yocto Project 3.0 Release.
- * - 3.1
- - April 2020
- - Released with the Yocto Project 3.1 Release.
-
diff --git a/documentation/ref-manual/index.rst b/documentation/ref-manual/index.rst
index 5cf10c5c2f..a746dde492 100644
--- a/documentation/ref-manual/index.rst
+++ b/documentation/ref-manual/index.rst
@@ -25,6 +25,5 @@ Yocto Project Reference Manual
varlocality
faq
resources
- history
.. include:: /boilerplate.rst
diff --git a/documentation/sdk-manual/history.rst b/documentation/sdk-manual/history.rst
deleted file mode 100644
index 8c10f6d2ee..0000000000
--- a/documentation/sdk-manual/history.rst
+++ /dev/null
@@ -1,40 +0,0 @@
-.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
-
-***********************
-Manual Revision History
-***********************
-
-.. list-table::
- :widths: 10 15 40
- :header-rows: 1
-
- * - Revision
- - Date
- - Note
- * - 2.1
- - April 2016
- - The initial document released with the Yocto Project 2.1 Release
- * - 2.2
- - October 2016
- - Released with the Yocto Project 2.2 Release.
- * - 2.3
- - May 2017
- - Released with the Yocto Project 2.3 Release.
- * - 2.4
- - October 2017
- - Released with the Yocto Project 2.4 Release.
- * - 2.5
- - May 2018
- - Released with the Yocto Project 2.5 Release.
- * - 2.6
- - November 2018
- - Released with the Yocto Project 2.6 Release.
- * - 2.7
- - May 2019
- - Released with the Yocto Project 2.7 Release.
- * - 3.0
- - October 2019
- - Released with the Yocto Project 3.0 Release.
- * - 3.1
- - April 2020
- - Released with the Yocto Project 3.1 Release.
diff --git a/documentation/sdk-manual/index.rst b/documentation/sdk-manual/index.rst
index fce2b199c7..dc7186b911 100644
--- a/documentation/sdk-manual/index.rst
+++ b/documentation/sdk-manual/index.rst
@@ -17,6 +17,5 @@ Yocto Project Application Development and the Extensible Software Development Ki
appendix-obtain
appendix-customizing
appendix-customizing-standard
- history
.. include:: /boilerplate.rst
diff --git a/documentation/test-manual/history.rst b/documentation/test-manual/history.rst
deleted file mode 100644
index 89d4aad21c..0000000000
--- a/documentation/test-manual/history.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
-
-***********************
-Manual Revision History
-***********************
-
-.. list-table::
- :widths: 10 15 40
- :header-rows: 1
-
- * - Revision
- - Date
- - Note
- * - 3.2
- - October 2020
- - The initial document released with the Yocto Project 3.2 Release
diff --git a/documentation/test-manual/index.rst b/documentation/test-manual/index.rst
index 4c590a6aa9..86a2f436ea 100644
--- a/documentation/test-manual/index.rst
+++ b/documentation/test-manual/index.rst
@@ -15,6 +15,5 @@ Yocto Project Test Environment Manual
understand-autobuilder
reproducible-builds
yocto-project-compatible
- history
.. include:: /boilerplate.rst
diff --git a/documentation/toaster-manual/history.rst b/documentation/toaster-manual/history.rst
deleted file mode 100644
index 05b63e5b9a..0000000000
--- a/documentation/toaster-manual/history.rst
+++ /dev/null
@@ -1,46 +0,0 @@
-.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
-
-***********************
-Manual Revision History
-***********************
-
-.. list-table::
- :widths: 10 15 40
- :header-rows: 1
-
- * - Revision
- - Date
- - Note
- * - 1.8
- - April 2015
- - The initial document released with the Yocto Project 1.8 Release
- * - 2.0
- - October 2015
- - Released with the Yocto Project 2.0 Release.
- * - 2.1
- - April 2016
- - Released with the Yocto Project 2.1 Release.
- * - 2.2
- - October 2016
- - Released with the Yocto Project 2.2 Release.
- * - 2.3
- - May 2017
- - Released with the Yocto Project 2.3 Release.
- * - 2.4
- - October 2017
- - Released with the Yocto Project 2.4 Release.
- * - 2.5
- - May 2018
- - Released with the Yocto Project 2.5 Release.
- * - 2.6
- - November 2018
- - Released with the Yocto Project 2.6 Release.
- * - 2.7
- - May 2019
- - Released with the Yocto Project 2.7 Release.
- * - 3.0
- - October 2019
- - Released with the Yocto Project 3.0 Release.
- * - 3.1
- - April 2020
- - Released with the Yocto Project 3.1 Release.
diff --git a/documentation/toaster-manual/index.rst b/documentation/toaster-manual/index.rst
index f13ba7b8a1..3ff4c6913a 100644
--- a/documentation/toaster-manual/index.rst
+++ b/documentation/toaster-manual/index.rst
@@ -14,6 +14,5 @@ Toaster User Manual
start
setup-and-use
reference
- history
.. include:: /boilerplate.rst
--
2.25.1
^ permalink raw reply related [flat|nested] 6+ messages in thread* Re: [docs] [PATCH] manuals: delete unmaintained history sections
2021-09-14 14:59 [PATCH] manuals: delete unmaintained history sections Michael Opdenacker
@ 2021-09-15 10:59 ` Quentin Schulz
2021-09-15 13:15 ` Michael Opdenacker
0 siblings, 1 reply; 6+ messages in thread
From: Quentin Schulz @ 2021-09-15 10:59 UTC (permalink / raw)
To: Michael Opdenacker; +Cc: docs
Hi Michael,
On Tue, Sep 14, 2021 at 04:59:30PM +0200, Michael Opdenacker wrote:
> This deletes the history sections in each sub-manual,
> which didn't add any value, given that they didn't list
> the changes from one Yocto Project version to the next.
>
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
I think it would still make sense to have this information somewhere in
the docs, to at least highlight how old the release you're using is.
Something like:
https://wiki.yoctoproject.org/wiki/Releases
but in the docs.
I assume we would need to handle this docs.yoctoproject.org wide and not
per release as otherwise it'll fall out of sync again.
In any case, just food for thoughts.
Reviewed-by: Quentin Schulz <foss@0leil.net>
Quentin
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [docs] [PATCH] manuals: delete unmaintained history sections
2021-09-15 10:59 ` [docs] " Quentin Schulz
@ 2021-09-15 13:15 ` Michael Opdenacker
2021-09-15 15:49 ` Quentin Schulz
0 siblings, 1 reply; 6+ messages in thread
From: Michael Opdenacker @ 2021-09-15 13:15 UTC (permalink / raw)
To: Quentin Schulz; +Cc: docs
Hi Quentin,
Thanks for the review!
On 9/15/21 12:59 PM, Quentin Schulz wrote:
> Hi Michael,
>
> On Tue, Sep 14, 2021 at 04:59:30PM +0200, Michael Opdenacker wrote:
>> This deletes the history sections in each sub-manual,
>> which didn't add any value, given that they didn't list
>> the changes from one Yocto Project version to the next.
>>
>> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> I think it would still make sense to have this information somewhere in
> the docs, to at least highlight how old the release you're using is.
>
> Something like:
> https://wiki.yoctoproject.org/wiki/Releases
> but in the docs.
>
> I assume we would need to handle this docs.yoctoproject.org wide and not
> per release as otherwise it'll fall out of sync again.
>
> In any case, just food for thoughts.
I'm not sure about the usefulness of a table that is just in parallel
with the Yocto Project versions, as in what we have today (e.g. on
https://docs.yoctoproject.org/kernel-dev/history.html).
However, it may be useful indeed to keep track of the YP version for
which the documentation was generated. Otherwise, for copies that are
not published on our website, the only way to figure this out seems to
be the latest version mentioned in the migration guides.
Something such as "Last updated on Sep 13, 2021, for Yocto Project
release 3.4" in the common footer, instead of just "Last updated on Sep
13, 2021". I could use "&YOCTO_DOC_VERSION;" to get this and it would
work without extra effort from the people managing the releases.
What do you think?
Thanks again,
Michael.
--
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [docs] [PATCH] manuals: delete unmaintained history sections
2021-09-15 13:15 ` Michael Opdenacker
@ 2021-09-15 15:49 ` Quentin Schulz
2021-09-15 16:19 ` Michael Opdenacker
[not found] ` <16A50B3E9F31C51C.29450@lists.yoctoproject.org>
0 siblings, 2 replies; 6+ messages in thread
From: Quentin Schulz @ 2021-09-15 15:49 UTC (permalink / raw)
To: docs, Michael Opdenacker, Quentin Schulz
On September 15, 2021 3:15:10 PM GMT+02:00, Michael Opdenacker <michael.opdenacker@bootlin.com> wrote:
>Hi Quentin,
>
>Thanks for the review!
>
>On 9/15/21 12:59 PM, Quentin Schulz wrote:
>> Hi Michael,
>>
>> On Tue, Sep 14, 2021 at 04:59:30PM +0200, Michael Opdenacker wrote:
>>> This deletes the history sections in each sub-manual,
>>> which didn't add any value, given that they didn't list
>>> the changes from one Yocto Project version to the next.
>>>
>>> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
>> I think it would still make sense to have this information somewhere in
>> the docs, to at least highlight how old the release you're using is.
>>
>> Something like:
>> https://wiki.yoctoproject.org/wiki/Releases
>> but in the docs.
>>
>> I assume we would need to handle this docs.yoctoproject.org wide and not
>> per release as otherwise it'll fall out of sync again.
>>
>> In any case, just food for thoughts.
>
>
>I'm not sure about the usefulness of a table that is just in parallel
>with the Yocto Project versions, as in what we have today (e.g. on
>https://docs.yoctoproject.org/kernel-dev/history.html).
>
Isn't this patch about removing this page?
Having at least a link in the documentation (might be to some URL outside of docs) to highlight when a release was.. released and when it went EOL. Also the name and number of the release.
We currently state that the doc you're looking at is outdated but there is a difference between being 6 months behind and being 5 years behind 😁
The issue is that what is stored in this link should not need to be updated for every docs branch otherwise it will fall out-of-date pretty quickly.
>However, it may be useful indeed to keep track of the YP version for
>which the documentation was generated. Otherwise, for copies that are
>not published on our website, the only way to figure this out seems to
>be the latest version mentioned in the migration guides.
>
>Something such as "Last updated on Sep 13, 2021, for Yocto Project
>release 3.4" in the common footer, instead of just "Last updated on Sep
>13, 2021". I could use "&YOCTO_DOC_VERSION;" to get this and it would
>work without extra effort from the people managing the releases.
>
>What do you think?
>
I think those are different topics, so I may not have conveyed my idea the way I intended to.
On that topic, I can suggest Something like "Yocto Project documentation release 3.4 - Last updated on Sep 13, 2021"?
But yeah, it could be a good idea especially if the footer is at the bottom of each page on a PDF version of the doc.
Cheers,
Quentin
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: [docs] [PATCH] manuals: delete unmaintained history sections
2021-09-15 15:49 ` Quentin Schulz
@ 2021-09-15 16:19 ` Michael Opdenacker
[not found] ` <16A50B3E9F31C51C.29450@lists.yoctoproject.org>
1 sibling, 0 replies; 6+ messages in thread
From: Michael Opdenacker @ 2021-09-15 16:19 UTC (permalink / raw)
To: Quentin Schulz, docs, Quentin Schulz; +Cc: michael.opdenacker
Hi Quentin,
On 9/15/21 5:49 PM, Quentin Schulz wrote:
> Isn't this patch about removing this page?
>
> Having at least a link in the documentation (might be to some URL outside of docs) to highlight when a release was.. released and when it went EOL. Also the name and number of the release.
I agree that we need proper documentation about release and EOL dates
for each release, and not just a wiki page. I'm tracking this:
https://bugzilla.yoctoproject.org/show_bug.cgi?id=14503However, it may
be useful indeed to keep track of the YP version for
>> which the documentation was generated. Otherwise, for copies that are
>> not published on our website, the only way to figure this out seems to
>> be the latest version mentioned in the migration guides.
>>
>> Something such as "Last updated on Sep 13, 2021, for Yocto Project
>> release 3.4" in the common footer, instead of just "Last updated on Sep
>> 13, 2021". I could use "&YOCTO_DOC_VERSION;" to get this and it would
>> work without extra effort from the people managing the releases.
>>
>> What do you think?
>>
> I think those are different topics, so I may not have conveyed my idea the way I intended to.
>
> On that topic, I can suggest Something like "Yocto Project documentation release 3.4 - Last updated on Sep 13, 2021"?
>
> But yeah, it could be a good idea especially if the footer is at the bottom of each page on a PDF version of the doc.
Sure, I'll propose another change to address this.
Cheers,
Michael.
--
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
^ permalink raw reply [flat|nested] 6+ messages in thread[parent not found: <16A50B3E9F31C51C.29450@lists.yoctoproject.org>]
* Re: [docs] [PATCH] manuals: delete unmaintained history sections
[not found] ` <16A50B3E9F31C51C.29450@lists.yoctoproject.org>
@ 2021-09-15 16:52 ` Michael Opdenacker
0 siblings, 0 replies; 6+ messages in thread
From: Michael Opdenacker @ 2021-09-15 16:52 UTC (permalink / raw)
To: Quentin Schulz, docs, Quentin Schulz
Greetings,
On 9/15/21 6:19 PM, Michael Opdenacker wrote:
>>> Something such as "Last updated on Sep 13, 2021, for Yocto Project
>>> release 3.4" in the common footer, instead of just "Last updated on Sep
>>> 13, 2021". I could use "&YOCTO_DOC_VERSION;" to get this and it would
>>> work without extra effort from the people managing the releases.
>>>
>>> What do you think?
>>>
>> I think those are different topics, so I may not have conveyed my idea the way I intended to.
>>
>> On that topic, I can suggest Something like "Yocto Project documentation release 3.4 - Last updated on Sep 13, 2021"?
>>
>> But yeah, it could be a good idea especially if the footer is at the bottom of each page on a PDF version of the doc.
>
> Sure, I'll propose another change to address this.
Actually, this turns out to be unnecessary IMHO. The version name is
already shown at the top of the left bar and also on each page of the
PDF output. That should be easy enough to identify the version.
Cheers,
Michael.
--
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2021-09-15 16:52 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-09-14 14:59 [PATCH] manuals: delete unmaintained history sections Michael Opdenacker
2021-09-15 10:59 ` [docs] " Quentin Schulz
2021-09-15 13:15 ` Michael Opdenacker
2021-09-15 15:49 ` Quentin Schulz
2021-09-15 16:19 ` Michael Opdenacker
[not found] ` <16A50B3E9F31C51C.29450@lists.yoctoproject.org>
2021-09-15 16:52 ` Michael Opdenacker
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).