| Message ID | 20220414110847.56425-1-abongwabonalais@gmail.com |
|---|---|
| State | New |
| Headers | show |
| Series | yocto-docs: profile manual, added banner at the top for direction to most recent website for version 3.1.3 | expand |
Hi Amahnui, On 4/14/22 13:08, Abongwa Amahnui Bonalais wrote: > Signed-off-by: Abongwa Bonalais Amahnui <abongwabonalais@gmail.com> > --- > 3.1.3/profile-manual/profile-manual-style.css | 28 ++++++++++++++++--- > 3.1.3/profile-manual/profile-manual.html | 6 +++- > 2 files changed, 29 insertions(+), 5 deletions(-) > > diff --git a/3.1.3/profile-manual/profile-manual-style.css b/3.1.3/profile-manual/profile-manual-style.css > index f3cca853..8f1e1d41 100644 > --- a/3.1.3/profile-manual/profile-manual-style.css > +++ b/3.1.3/profile-manual/profile-manual-style.css > @@ -43,11 +43,31 @@ > body { > font-family: Verdana, Sans, sans-serif; > > - min-width: 640px; > - width: 80%; > - margin: 0em auto; > - padding: 2em 5em 5em 5em; > + /*min-width: 640px;*/ > + width: 100%; > + margin: 0; > + padding: 0; > color: #333; > + overflow-x: hidden; > + } > + > + /*added books too*/ > +.book{ > +margin: 0 auto; > +min-width: 640px; > +padding: 0 5em 5em 5em; > +} > +/* added the id below to make the banner show and be fixed*/ > +#outdated-warning{ > +text-align: center; > +background-color: rgb(255, 186, 186); > +color: rgb(106, 14, 14); > +padding: 0.5em 50px; I think we want `0.5em 0` here otherwise it's not properly centered. Otherwise, I tested and it looks very nice. That was something we needed for a long time. I'm happy someone finally had a go at it (was on my todo list for too long I even forgot about it). > +width: 100%; > +position: fixed; > +top: 0; > + > + > } > > h1,h2,h3,h4,h5,h6,h7 { > diff --git a/3.1.3/profile-manual/profile-manual.html b/3.1.3/profile-manual/profile-manual.html > index b81f5b21..50cb0ca8 100644 > --- a/3.1.3/profile-manual/profile-manual.html > +++ b/3.1.3/profile-manual/profile-manual.html > @@ -1,6 +1,10 @@ > <?xml version="1.0" encoding="UTF-8"?> > -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://urldefense.proofpoint.com/v2/url?u=http-3A__www.w3.org_TR_xhtml1_DTD_xhtml1-2Dtransitional.dtd&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=ktcTcNWRieYYZQxRp1v4xxDrJAPBWfnjv04wyhDCBuFksDHg0X7Sari9FmDKTgxv&s=6eE2smL0EWIGKu4horQOjFq0INsRBqeKFtgj_cYe3JI&e= "><html xmlns="https://urldefense.proofpoint.com/v2/url?u=http-3A__www.w3.org_1999_xhtml&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=ktcTcNWRieYYZQxRp1v4xxDrJAPBWfnjv04wyhDCBuFksDHg0X7Sari9FmDKTgxv&s=QDCBGOLobUBlVKzOwDanMRX0MCKsWMNFoVCzT7EGWV8&e= "><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Yocto Project Profiling and Tracing Manual</title><link rel="stylesheet" type="text/css" href="profile-manual-style.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="book" title="Yocto Project Profiling and Tracing Manual" id="profile-manual" lang="en"><div class="titlepage"><div><div><h1 class="title"> > +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://urldefense.proofpoint.com/v2/url?u=http-3A__www.w3.org_TR_xhtml1_DTD_xhtml1-2Dtransitional.dtd&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=ktcTcNWRieYYZQxRp1v4xxDrJAPBWfnjv04wyhDCBuFksDHg0X7Sari9FmDKTgxv&s=6eE2smL0EWIGKu4horQOjFq0INsRBqeKFtgj_cYe3JI&e= "><html xmlns="https://urldefense.proofpoint.com/v2/url?u=http-3A__www.w3.org_1999_xhtml&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=ktcTcNWRieYYZQxRp1v4xxDrJAPBWfnjv04wyhDCBuFksDHg0X7Sari9FmDKTgxv&s=QDCBGOLobUBlVKzOwDanMRX0MCKsWMNFoVCzT7EGWV8&e= "><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Yocto Project Profiling and Tracing Manual</title><link rel="stylesheet" type="text/css" href="profile-manual-style.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head> > +<body> > + <div id="outdated-warning">Version 3.1.3 of the project is now considered obsolete, please select and use a more recent version</div> Up to the maintainers to decide, but to keep consistent behavior with the current docs website, we should have: For 3.1.3: This document is for outdated version 3.1.3, you should select the latest release version in this series. For 3.0.4: Version 3.0.4 of the project is now considered obsolete, please select and use a more recent version. I think we should also have a link somewhere to point to the new docs website (https://docs.yoctoproject.org). As mentioned on IRC by Richard, we need this to be applied to the sources used to build the old docs website. The sources are extracted here: https://git.yoctoproject.org/yocto-autobuilder-helper/tree/scripts/run-docs-build#n30 and all files of all versions need to have those headers displayed. Thanks a ton for having a look at this, it really is a great addition to our docs! Quentin
Hi Amahnui, Just as a side note, most of your mails are directly going to my spam folder for some reason... On 4/14/22 16:36, Abongwa Amahnui Bonalais wrote: > Hi Quentin, > Thanks for the review, > I did the changes and will send an updated patch for it. > How do I generate the docs using https://urldefense.proofpoint.com/v2/url?u=https-3A__git.yoctoproject.org_yocto-2Dautobuilder-2Dhelper_tree_scripts_run-2Ddocs-2Dbuild-23n30&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=r_YYPHwgWQWonlQ4R0-hCuxHUSxfOMH0MldT-b6vCal6sYhWkZtrMHDuFKkzyLJV&s=x4IXi0wCgjGiVHOMdgkOzlb3-KTA0afHRTsTfnXF1xo&e= > I'm confused on how to use it to generate the docs > The arguments to give to the script are listed in the header of the script. What I usually do is: git clone https://git.yoctoproject.org/yocto-autobuilder-helper cd yocto-autobuilder-helper/scripts/ Here you want to modify docs_buildtools variable to point to the buildtools script (don't know where to get it to be honest, I know https://autobuilder.yocto.io/pub/non-release/20220413-28/buildtools/x86_64-buildtools-docs-nativesdk-standalone-4.0.sh should be one way to get a non-released one though). You also want to modify docbookarchive variable to point to the location of the docbook-mirror tarball you downloaded. Then you want to comment out the rsync calls and that should be about it. Then run the following: mkdir build git clone https://git.yoctoproject.org/yocto-docs git clone https://git.openembedded.org/bitbake/ ./run-docs-build "$PWD/build" "$PWD/yocto-docs" "$PWD/bitbake" Hope this helps, Quentin > > > -=-=-=-=-=-=-=-=-=-=-=- > Links: You receive all messages sent to this group. > View/Reply Online (#2771): https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_message_2771&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=r_YYPHwgWQWonlQ4R0-hCuxHUSxfOMH0MldT-b6vCal6sYhWkZtrMHDuFKkzyLJV&s=0afxvmvNcCQ_6_IOebB22n-aCzzHXcJskFVkW6s22H0&e= > Mute This Topic: https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_mt_90461516_6293953&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=r_YYPHwgWQWonlQ4R0-hCuxHUSxfOMH0MldT-b6vCal6sYhWkZtrMHDuFKkzyLJV&s=SJ5fXNVS5HXKdMpCFc-lmcJqcKoGG06p2YFCK9NQXuk&e= > Group Owner: docs+owner@lists.yoctoproject.org > Unsubscribe: https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_unsub&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=r_YYPHwgWQWonlQ4R0-hCuxHUSxfOMH0MldT-b6vCal6sYhWkZtrMHDuFKkzyLJV&s=cTG27GeTv--8el0lwC1Q6Yrb_etZ5g-scrCOo1E8loQ&e= [quentin.schulz@theobroma-systems.com] > -=-=-=-=-=-=-=-=-=-=-=- >
Thanks for this, I have been having network issues for the past 2 days.
Hello Quentin, when I run ./run-docs-build "$PWD/build" "$PWD/yocto-docs" "$PWD/bitbake", I get the error below In an attempt to generate the docs using auto-builder-helper tool tar (child): /home/abongwa/Pictures/docbook-archives-20201105: Cannot read: Is a directory tar (child): At beginning of tape, quitting now tar (child): Error is not recoverable: exiting now xz: (stdin): File format not recognized tar: Child returned status 2 tar: Error is not recoverable: exiting now
This is the complete error log
Hi Amahnui, On April 20, 2022 11:18:07 PM GMT+02:00, Abongwa Amahnui Bonalais <abongwabonalais@gmail.com> wrote: >Hello Quentin, when I run ./run-docs-build "$PWD/build" "$PWD/yocto-docs" "$PWD/bitbake", I get the error below >In an attempt to generate the docs using auto-builder-helper tool > >tar (child): /home/abongwa/Pictures/docbook-archives-20201105: Cannot read: Is a directory >tar (child): At beginning of tape, quitting now >tar (child): Error is not recoverable: exiting now >xz: (stdin): File format not recognized >tar: Child returned status 2 >tar: Error is not recoverable: exiting now You need to give the path to the compressed archive (also called tarball) and not the path to the directory where it is extracted. The script will extract it for you. Cheers, Quentin
Hello Quentin, I wish to ask if I there is a way in which I can make a script in yocto-autobuilder-helper/scripts run last.
diff --git a/3.1.3/profile-manual/profile-manual-style.css b/3.1.3/profile-manual/profile-manual-style.css index f3cca853..8f1e1d41 100644 --- a/3.1.3/profile-manual/profile-manual-style.css +++ b/3.1.3/profile-manual/profile-manual-style.css @@ -43,11 +43,31 @@ body { font-family: Verdana, Sans, sans-serif; - min-width: 640px; - width: 80%; - margin: 0em auto; - padding: 2em 5em 5em 5em; + /*min-width: 640px;*/ + width: 100%; + margin: 0; + padding: 0; color: #333; + overflow-x: hidden; + } + + /*added books too*/ +.book{ +margin: 0 auto; +min-width: 640px; +padding: 0 5em 5em 5em; +} +/* added the id below to make the banner show and be fixed*/ +#outdated-warning{ +text-align: center; +background-color: rgb(255, 186, 186); +color: rgb(106, 14, 14); +padding: 0.5em 50px; +width: 100%; +position: fixed; +top: 0; + + } h1,h2,h3,h4,h5,h6,h7 { diff --git a/3.1.3/profile-manual/profile-manual.html b/3.1.3/profile-manual/profile-manual.html index b81f5b21..50cb0ca8 100644 --- a/3.1.3/profile-manual/profile-manual.html +++ b/3.1.3/profile-manual/profile-manual.html @@ -1,6 +1,10 @@ <?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Yocto Project Profiling and Tracing Manual</title><link rel="stylesheet" type="text/css" href="profile-manual-style.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="book" title="Yocto Project Profiling and Tracing Manual" id="profile-manual" lang="en"><div class="titlepage"><div><div><h1 class="title"> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Yocto Project Profiling and Tracing Manual</title><link rel="stylesheet" type="text/css" href="profile-manual-style.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head> +<body> + <div id="outdated-warning">Version 3.1.3 of the project is now considered obsolete, please select and use a more recent version</div> + <div xml:lang="en" class="book" title="Yocto Project Profiling and Tracing Manual" id="profile-manual" lang="en"><div class="titlepage"><div><div><h1 class="title"> Yocto Project Profiling and Tracing Manual + </h1></div><div><div class="authorgroup"> <div class="author"><h3 class="author"></h3><div class="affiliation"> <span class="orgname">The Yocto Project<br /></span>
Signed-off-by: Abongwa Bonalais Amahnui <abongwabonalais@gmail.com> --- 3.1.3/profile-manual/profile-manual-style.css | 28 ++++++++++++++++--- 3.1.3/profile-manual/profile-manual.html | 6 +++- 2 files changed, 29 insertions(+), 5 deletions(-)