search

girder / girder_web_components

Reusable Javascript and VueJS components for interacting with a Girder server.
https://gwc.girder.org
Apache License 2.0
16 stars 9 forks source link

README screenshot #135

Closed subdavis closed 4 years ago

subdavis commented 5 years ago

I thought README.md needed a nice screenshot of GWC to add a little jazz. I think a screenshot will make people more likely to try the demo or at least invoke a feeling of "hey this looks polished".

You can see how it looks here

zachmullen commented 5 years ago

Great idea! There has hitherto been zero marketing material in this repo, people would really have no idea what it's even useful for. I think we should also add two more screenshots to cover the "big three" components, with a little label under each one, "DataBrowser Component", "Authentication Component", "Upload Component".

subdavis commented 5 years ago

Agreed. I'll add the other 2 in some kind of configuration.

matthewma7 commented 5 years ago

This looks great!

But maybe we want to use a GitHub issue or this PR to hold the image, so the screenshot image won't be part of the source code?

subdavis commented 5 years ago

@matthewma7 referencing an image by relative path is a neat feature supported by github to enable exactly this. I don't see any reason not to keep documentation like this checked in.

matthewma7 commented 5 years ago

The reason is that it bloats up the repo and git history? When we update this image in the future, versions of the image will still live inside git history.

waxlamp commented 5 years ago

yarn.lock by itself is 367K, while this screencap is only 33K. If we're talking about updating the image in every PR, then I can see how the bloat would become a problem but for now I don't see why we couldn't just include the image in the repo.

zachmullen commented 5 years ago

Let's just put any smallish binary assets in a single directory, that would make it easy to prune from history later if we decide they're causing too much bloat.

subdavis commented 5 years ago

Do this after #154, since things will look different.

subdavis commented 4 years ago

Seems unnecessary given gwc.girder.org

It's not like we're trying to sell this externally. GWC already has decent brand awareness, I don't think it would be worth the effort of keeping it updated.