Re: [docs] [PATCH] yocto-docs: profile manual, added banner at the top for direction to most recent website for version 3.1.3

From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
To: Abongwa Amahnui Bonalais <abongwabonalais@gmail.com>,
	docs@lists.yoctoproject.org
Subject: Re: [docs] [PATCH] yocto-docs: profile manual, added banner at the top for direction to most recent website for version 3.1.3
Date: Thu, 14 Apr 2022 16:02:11 +0200	[thread overview]
Message-ID: <780350cf-fb98-e73d-ebaf-a52bd059fd70@theobroma-systems.com> (raw)
In-Reply-To: <20220414110847.56425-1-abongwabonalais@gmail.com>

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