| Message ID | 20220318162945.1072835-2-richard.purdie@linuxfoundation.org |
|---|---|
| State | New |
| Headers | show |
| Series | [1/2] set_versions/switchers.js: Allow switchers.js version information to be autogenerated | expand |
Hi Richard, On 3/18/22 17:29, Richard Purdie wrote: > Ensure older non-active releases are shown in the switchers.js > release list. > We're currently showing EOL releases in the docs too. I think we need to discuss this first before removing EOL releases in the previous patch (pretty sure I commented on another patchseries questioning this decision). I don't think it's a good idea to mask them but I'm happy to be proven otherwise :) Cheers, Quentin
On Mon, 2022-03-21 at 18:11 +0100, Quentin Schulz wrote: > Hi Richard, > > On 3/18/22 17:29, Richard Purdie wrote: > > Ensure older non-active releases are shown in the switchers.js > > release list. > > > > We're currently showing EOL releases in the docs too. I think we need to > discuss this first before removing EOL releases in the previous patch > (pretty sure I commented on another patchseries questioning this > decision). I don't think it's a good idea to mask them but I'm happy to > be proven otherwise :) I'm of the view that we should show the currently supported ones by default. You can navigate to the older ones or follow links to them but we want to give users a strong hint about which versions they should be looking at, and hint to them if they're on old versions... Cheers, Richard
Hi Richard, On 3/21/22 18:14, Richard Purdie wrote: > On Mon, 2022-03-21 at 18:11 +0100, Quentin Schulz wrote: >> Hi Richard, >> >> On 3/18/22 17:29, Richard Purdie wrote: >>> Ensure older non-active releases are shown in the switchers.js >>> release list. >>> >> >> We're currently showing EOL releases in the docs too. I think we need to >> discuss this first before removing EOL releases in the previous patch >> (pretty sure I commented on another patchseries questioning this >> decision). I don't think it's a good idea to mask them but I'm happy to >> be proven otherwise :) > > I'm of the view that we should show the currently supported ones by default. You > can navigate to the older ones or follow links to them but we want to give users > a strong hint about which versions they should be looking at, and hint to them > if they're on old versions... > https://docs.yoctoproject.org/3.0.4/ Shows a red HTML header. It's a policy decision. I know it's been hard to encourage people to move to actually supported versions of the Yocto Project, so maybe removing explicit links to the docs is sufficiently annoying for people to think about migrating? I don't know. Not nice to users but can see the reason for the project to go this route. Cheers, Quentin
diff --git a/documentation/set_versions.py b/documentation/set_versions.py index d9f57112b..394e3f7e4 100755 --- a/documentation/set_versions.py +++ b/documentation/set_versions.py @@ -145,6 +145,9 @@ with open("poky.yaml.in", "r") as r, open("poky.yaml", "w") as w: print("poky.yaml generated from poky.yaml.in") +if ourseries not in activereleases: + activereleases.append(ourseries) + with open("sphinx-static/switchers.js.in", "r") as r, open("sphinx-static/switchers.js", "w") as w: lines = r.readlines() for line in lines:
Ensure older non-active releases are shown in the switchers.js release list. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> --- documentation/set_versions.py | 3 +++ 1 file changed, 3 insertions(+)