Bug 14394 - Add a banner on the old documentation docs
Summary: Add a banner on the old documentation docs
Status: RESOLVED FIXED
Alias: None
Product: General Docs
Classification: Documentation
Component: docs-general (show other bugs)
Version: unspecified
Hardware: x86 Multiple
: Medium+ normal
Target Milestone: 4.1 M1
Assignee: Abongwa Bonalais Amahnui
QA Contact:
URL:
Whiteboard:
Depends on:
Blocks:
 
Reported: 2021-05-14 09:25 UTC by Nicolas Dechesne
Modified: 2022-06-23 14:54 UTC (History)
6 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Don't know


Attachments
THis is the complete error log (354.63 KB, image/png)
2022-04-20 22:16 UTC, Abongwa Bonalais Amahnui
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Nicolas Dechesne 2021-05-14 09:25:55 UTC
The old docs are still available, e.g. https://yoctoproject.org/docs/latest/mega-manual/mega-manual.html#required-packages-for-the-build-host even if we added a redirect from http://yoctoproject.org/docs to docs.yoctoproject.org.

It's probably a 'good' idea to keep the old docs around since they are probably used in many places.. but Ross suggested to me that we could at least add a banner at the top of the pages to indicate the address of the new docs.

I think it's a good idea.
Comment 1 Michael Opdenacker 2021-07-29 17:07:42 UTC
This sounds like a good idea indeed.
Adding Michael Halstead to know how such documents could be modified to add a banner.
Comment 2 Michael Opdenacker 2021-10-05 08:53:23 UTC
Assigning this bug to Michael Halstead as I cannot do anything about it.
Don't hesitate to assign it back to me once I am given the rights (and details!) to update the corresponding pages.
Comment 3 Alexander Kanavin 2022-01-10 21:55:13 UTC
Yes please. People constantly land on them via google search, and it's counter-productive and confusing.
Comment 5 Richard Purdie 2022-03-24 21:58:30 UTC
There are two issues here:

Firstly, we need to redirect versioned manuals on the old website to the docs site. That is something Michael Halstead probably needs to address.

Secondly, we need to go through the "static" content and work out how to add banners to all the old manuals. Does anyone know how to do that to our old generated docbook manuals? Not sure who could do this?
Comment 6 Abongwa Bonalais Amahnui 2022-04-15 18:13:22 UTC
Hello, it shows here that this bug has been assigned already to Michael Halstead. 
Should I keep looking for a fix for it?
Comment 7 Michael Opdenacker 2022-04-15 19:25:55 UTC
Oh yes, your help is most welcome!
Thanks for everything
Michael
Comment 8 Michael Halstead 2022-04-15 19:27:26 UTC
Please take over on this bug.

The first step is to download the old docs from https://downloads.yoctoproject.org/mirror/docbook-mirror/docbook-archives-20201105.tar.xz and modify them to contain the needed header. Prep a new tarball and put it into place.

Then we can update https://git.yoctoproject.org/yocto-autobuilder-helper/tree/scripts/run-docs-build#n26 to point to the new archive.

I will still need to handle the website redirects but this would help move the bug along.
Comment 9 Abongwa Bonalais Amahnui 2022-04-15 19:42:31 UTC
Thank you I actually have 2 python scripts that should be able to modify the .html and .css files. here is a patch for it https://lists.yoctoproject.org/g/yocto/topic/patch/90488259?p=,,,20,0,0,0::recentpostdate/sticky,,,20,2,0,90488259,previd%3D1650037941186289130,nextid%3D1649775663060863362&previd=1650037941186289130&nextid=1649775663060863362

The scripts return an error message when it encounters the utf-8 encoding(UnicodeDecodeError: 'utf-8' codec can't decode byte 0xa0 in position 99: invalid start byte') for the script modifying the html file, but it gives this error after successfully modifying the some of the html and css files.
Comment 10 Richard Purdie 2022-04-15 21:01:11 UTC
I think it may be easiest if we keep the tarball as is and let the scripts modify the result when run as part of the docs build script
Comment 11 Abongwa Bonalais Amahnui 2022-04-20 22:16:32 UTC
Created attachment 4861 [details]
THis is the complete error log

Hello everyone, when I run ./run-docs-build "$PWD/build" "$PWD/yocto-docs" "$PWD/bitbake" In an attempt to generate the docs using auto-builder-helper tool, I get the error below
Comment 12 Abongwa Bonalais Amahnui 2022-04-21 20:19:03 UTC
Hello the auto-builder-helper works now with the script for adding the banner.
I will send a patch for the auto-builder-helper modifications.
Comment 14 Abongwa Bonalais Amahnui 2022-05-03 09:07:24 UTC
Hello here is more recent patch for this bug. https://lists.yoctoproject.org/g/yocto/message/56921
Please I would like to request for a review of it.
Comment 15 Michael Opdenacker 2022-06-16 16:14:15 UTC
The changes are merged in the yocto-autobuilder-helper repository, but we are still missing banners on https://www.yoctoproject.org/docs/1.8.1/adt-manual/adt-manual.html for example.

Any clue why?
Thanks
Michael.
Comment 16 Randy MacLeod 2022-06-23 14:54:41 UTC
The link from the previous comment works now.