search

crate / cloud-docs

Documentation for CrateDB Cloud.
https://crate.io/docs/cloud/
Apache License 2.0
0 stars 1 forks source link

Update Edge Introduction pictures #53

Closed matkuliak closed 6 months ago

matkuliak commented 6 months ago

Summary of the changes / Why this is an improvement

Checklist

amotl commented 6 months ago

Hi. Was it just some conversion using oxipng, or are those real updates? If the latter is the case, I would like to suggest to switch to a better style/paradigm of having screenshots in the documentation.

https://thisisimportant.net/posts/screenshots-in-documentation/ -- via: https://news.ycombinator.com/item?id=38639629

My proposal is to use the ideas from Simplified Screenshots exclusively, and apply them gradually when reworking the documentation, and when adding new content. wdyt?

While they might take a bit longer to make, simplified screenshots don’t need to be updated as frequently because you can obscure parts of the UI that are irrelevant for your task, unavailable to users with specific roles or permissions, or that might otherwise be confusing.

Sorry about that "more work" bit. My suggestion does not want to hide that it is more workload on the content authors. However, as you know we are aiming for documentation excellency, we humbly ask content authors to pay that tribute.

matkuliak commented 6 months ago

Hi. I see where you're coming from. Screenshots are highly debatable topic, I agree that we could do them better. For one, we could (should?) do fewer of them. I am guilty of this myself, it's easy to rely on them.

I added "screenshot overhaul" to my backlog and will consider your suggestion, thank you. Obscuring parts sound like a good idea to me.

amotl commented 6 months ago

Thanks!

Obscuring parts sound like a good idea to me.

Not only obscuring, but also cropping down to the element of interest. 👍