istio / istio.io

Source for the istio.io site
https://istio.io/
Apache License 2.0
757 stars 1.5k forks source link

consistent arch diagrams and images in docs #15195

Open peterj opened 1 month ago

peterj commented 1 month ago

At some point we should decide on a "style" and re-draw the diagrams across the docs, so they are all consistent and look & feel as they are part of the same product.

Existing resources

TODOs

craigbox commented 4 weeks ago

https://drive.google.com/file/d/1YRY7TYSfrkAbpHuYPjdeHUwZMMzDlPvh/view came with the 2020 design and is a good place to start. Want to see if you can get something templated that looks/feels like that?

peterj commented 3 weeks ago

Yep, I don't mind the look & feel, it's mostly about staying consistent throughout the documentation and updating the diagrams that don't fit the same look and feel. For example:

Screenshot 2024-06-03 at 1 55 05 PM

Screenshot 2024-06-03 at 1 55 57 PM

Screenshot 2024-06-03 at 1 56 36 PM

craigbox commented 3 weeks ago

(No disrespect to the authors, but all three are butt ugly, and I can point you to a dozen more!)

I don't think Excalidraw is going to cut it btw - I'm thinking we need Illustrator templates or something like Canva.

peterj commented 3 weeks ago

we can re-draw in other software, but then we’d need a process for adding any new diagrams and have someone draw them in a nicer looking way

On Mon, Jun 3, 2024 at 17:43 Craig Box @.***> wrote:

(No disrespect to the authors, but all three are butt ugly, and I can point you to a dozen more!)

I don't think Excalidraw is going to cut it btw - I'm thinking we need Illustrator templates or something like Canva.

— Reply to this email directly, view it on GitHub https://github.com/istio/istio.io/issues/15195#issuecomment-2146358077, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACURJ3BR7QPYGCEATSPTBHTZFUERXAVCNFSM6AAAAABIPOZTCWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNBWGM2TQMBXG4 . You are receiving this because you authored the thread.Message ID: @.***>

craigbox commented 3 weeks ago

We should optimize for whatever is the most likely to deliver consistent, nice looking output, that any contributor can easily access.

Then I can put a manual lint gate on people who don't submit drawings that look like the rest of the site in their blog posts 😁

(Maybe Google Slides isn't a bad choice?)