argoproj / argo-workflows

Workflow Engine for Kubernetes
https://argo-workflows.readthedocs.io/
Apache License 2.0
15.11k stars 3.21k forks source link

docs: add/remove elements for more clarity on the version of the docs you're on #13810

Open agilgur5 opened 4 weeks ago

agilgur5 commented 4 weeks ago

Motivation

In CNCF Tech Docs Office Hours on Sept 25th, a couple of items in the docs stood out as confusing or lacking clarity around versions, including the GH link and a lack of version in the header/logo/home button

Modifications

Verification

Visually inspected. See screenshots:

Before: Header: ![before header - Screenshot 2024-10-24 at 3 52 41 PM](https://github.com/user-attachments/assets/c7e43f74-bd05-4a6f-b1ab-c304f1ee76a5) SideNav: ![before sidenav - Screenshot 2024-10-24 at 3 53 27 PM](https://github.com/user-attachments/assets/a4096a7e-40fd-45cf-b412-1b3b921888a7)
After: Header: ![after header - Screenshot 2024-10-24 at 2 43 19 PM](https://github.com/user-attachments/assets/7acf7608-0d52-4b46-a342-4e4f0086ed6e) SideNav: ![after sidenav - Screenshot 2024-10-24 at 3 47 37 PM](https://github.com/user-attachments/assets/f4cc595d-e5fe-4617-a752-c2cdd05b698a)

Future Work

  1. [ ] Also add a floating version warning banner for old versions and latest, as mentioned in the TechDocs Office Hours (referencing https://github.com/etcd-io/website/issues/813) as well as my own comments in https://github.com/argoproj/argo-workflows/issues/11390#issuecomment-2007818981 (referencing CD's banner)