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

Add a second screenshot of the page in dark mode #271

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
![Screenshot of the main page](./screenshot.jpg)
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://i.imgur.com/o7Oj6Rg.png">
<img alt="A quick preview of our UI" src="https://i.imgur.com/79FolWw.png">
Comment on lines +2 to +3
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is nice! But I'm not sure if it's a good idea to store images outside of our repo, especially on the generic image hosting service like imgur:

Imgur keep images for ever as long as they are receiving at least 1 view every six months
https://www.quora.com/Imgur-How-long-are-the-images-stored-before-being-purged

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BracketJohn what's your take? Should we always keep images directly to the repo and potentially bloat its size over time? Or maybe use lfs for them (although I don't know if lfs will be displayed in the readme)?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, we should not rely on external hosting of our images:

  • may be purged accidentally (I don't think 1 view every six month is a guarantee, rather a policy)
  • outage of external provider will result in (partial) outage of our service
  • external provider may apply any sort of alteration to terms & conditions at any time (e.g.: injecting some sort of user tracking into image serving?)

We already have a lot of parties we have to blindly trust (AWS, github, drone, google, ...) and should be careful with adding another one.

Especially if our problem is already solved via git-lfs.

@BracketJohn what's your take? Should we always keep images directly to the repo and potentially bloat its size over time? Or maybe use lfs for them (although I don't know if lfs will be displayed in the readme)?

It's possible to reference git lfs images in readmes or elsewhere: https://stackoverflow.com/a/47371057

My take: It's fine to add images to our repos, you can decide when to introduce lfs to make it more efficient. Here we are talking about 305kb, for me this would be too early to introduce lfs.

</picture>

# Unified Auctions UI

Expand Down
Binary file removed screenshot.jpg
Binary file not shown.