kedro
kedro copied to clipboard
Get rid of GitHub magic in README [Quick Win]
@marrrcin reported that he saw the README like this
and it's because of a bad combination of the magic we're using to detect light/dark theme
https://github.com/kedro-org/kedro/blob/8257d55ec96abbc1ce18ae229da8c773c60bfc1b/README.md?plain=1#L1-L2
and how GitHub assumes night = dark
This has created other problems in the past https://github.com/kedro-org/kedro/pull/2961#issuecomment-1688542270
Given that this is broken on PyPI and half-broken on GitHub, I'd say let's get rid of this.
A strawman proposal would be something like
But better to have this properly designed.
Moving this to Viz as it'll be part of design initially and quite likely require web savvy too.
@SajidAlamQB also reported this issue on pypi - https://pypi.org/project/kedro/
We don't need tech design for this. We need to just do it.
I encountered this when publishing github action. The way we do conditional images is deprecated. This link should help.
@ravi-kumar-pilla could you check if the <picture>
thing is rendered correctly on PyPI?
@ravi-kumar-pilla could you check if the
<picture>
thing is rendered correctly on PyPI?
@astrojuanlu I see an open ticket - https://github.com/pypi/warehouse/issues/11251 . Needs some more searching/testing when we work on the ticket.
I tried testing the html and picture
tag seems to work fine -
The way to test this would be to upload a test version to https://test.pypi.org/project/kedro/ or a newly registered package only for testing purposes.
We tried to replicate this issue and it doesn't exist anymore for Readme anymore. It does exist for Pypi which we will work on fixing.