| Summary: | Add a banner on the old documentation docs | ||||||
|---|---|---|---|---|---|---|---|
| Product: | [Documentation] General Docs | Reporter: | Nicolas Dechesne <ndec13> | ||||
| Component: | docs-general | Assignee: | Abongwa Bonalais Amahnui <abongwabonalais> | ||||
| Status: | RESOLVED FIXED | QA Contact: | |||||
| Severity: | normal | ||||||
| Priority: | Medium+ | CC: | abongwabonalais, alex.kanavin, mhalstead, michael.opdenacker, randy.macleod, richard.purdie | ||||
| Version: | unspecified | ||||||
| Target Milestone: | 4.1 M1 | ||||||
| Hardware: | x86 | ||||||
| OS: | Multiple | ||||||
| Whiteboard: | |||||||
| OS type for building Yocto: | --- | Type of Regression: | --- | ||||
| Verified: | Documentation change: | Don't know | |||||
| Attachments: |
|
||||||
|
Description
Nicolas Dechesne
2021-05-14 09:25:55 UTC
This sounds like a good idea indeed. Adding Michael Halstead to know how such documents could be modified to add a banner. 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. Yes please. People constantly land on them via google search, and it's counter-productive and confusing. A better URL example is https://yoctoproject.org/docs/2.3/mega-manual/mega-manual.html#required-packages-for-the-build-host 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? Hello, it shows here that this bug has been assigned already to Michael Halstead. Should I keep looking for a fix for it? Oh yes, your help is most welcome! Thanks for everything Michael 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. 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. 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 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
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. https://lists.yoctoproject.org/g/yocto/topic/patch/90615391?p=,,,20,0,0,0::recentpostdate/sticky,,,20,2,0,90615391,previd%3D1650575035728991534,nextid%3D1650388072241693340&previd=1650575035728991534&nextid=1650388072241693340 Here is a patch for the changes. 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. 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. The link from the previous comment works now. |