Add custom lakeFS-spec logo/favicon

aai-institute / lakefs-spec

An fsspec implementation for the lakeFS project.

http://lakefs-spec.org/

Apache License 2.0

37 stars 4 forks source link

Add custom lakeFS-spec logo/favicon #238

Closed AdrianoKF closed 6 months ago

AdrianoKF commented 6 months ago

The PR adds a custom lakeFS-spec logo and favicon to the project and docs:

GitHub and PyPI README with dark/light mode support
Docs: Redesigned landing page (no more headline, added logo) and favicon
Raw Inkscape SVG under assets/ (note that this is a Multipage SVG, everything but the first page is only visible in Inkscape)

The dark/light mode switch using the HTML <picture> element with a media query should be compatible with PyPI's description renderer, based on my short experimentation.

As for the usage, I would suggest to use the light-mode version (i.e., the one with the darker text color) as the official logo, unless we specifically need to place it against a dark background.

GitHub Readme

Docs Landing page

codecov[bot] commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (946da5e) 91.19% compared to head (9c25cd8) 91.19%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #238 +/- ## ======================================= Coverage 91.19% 91.19% ======================================= Files 5 5 Lines 477 477 Branches 82 82 ======================================= Hits 435 435 Misses 24 24 Partials 18 18 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

nicholasjng commented 6 months ago

Awesome stuff! But the badges should go underneath the logo in my opinion.

AdrianoKF commented 6 months ago

Awesome stuff! But the badges should go underneath the logo in my opinion.

Done in 70733f7 (see https://github.com/aai-institute/lakefs-spec/blob/70733f7f3bf8406ecc7f25ade63a27b7e9f7553b/README.md).

nicholasjng commented 6 months ago

Could we move it under the headline (lakeFS-spec: An fsspec backend for lakeFS) too? I think that's standard practice.

See e.g. https://github.com/google/jax/#jax-autograd-and-xla or https://github.com/ml-explore/mlx

AdrianoKF commented 6 months ago

Could we move it under the headline (lakeFS-spec: An fsspec backend for lakeFS) too? I think that's standard practice.

See e.g. https://github.com/google/jax/#jax-autograd-and-xla or https://github.com/ml-explore/mlx

See 9c25cd8 / https://github.com/aai-institute/lakefs-spec/blob/9c25cd83956ea7cb235da8a147479db4baa78a05/README.md.

Actually, this looks much cleaner, thanks for the feedback!