Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

consistent arch diagrams and images in docs #15195

Open
3 tasks
peterj opened this issue May 29, 2024 · 5 comments
Open
3 tasks

consistent arch diagrams and images in docs #15195

peterj opened this issue May 29, 2024 · 5 comments

Comments

@peterj
Copy link
Member

peterj commented May 29, 2024

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

  • Update the diagram creation guidelines to match the brand guidelines
  • Create and publish a shared Excalidraw (or other) library of components/icons that are on brand
  • Update diagrams in the docs to match the new style
@craigbox
Copy link
Contributor

craigbox commented May 30, 2024

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
Copy link
Member Author

peterj commented Jun 3, 2024

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
Copy link
Contributor

craigbox commented Jun 4, 2024

(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
Copy link
Member Author

peterj commented Jun 4, 2024 via email

@craigbox
Copy link
Contributor

craigbox commented Jun 4, 2024

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?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants