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

docs: remove tracking pixels, update to transparent Redpanda logo #17822

Merged
merged 4 commits into from
Apr 18, 2024

Conversation

WillemKauf
Copy link
Contributor

@WillemKauf WillemKauf commented Apr 12, 2024

  1. We had two tracking pixels in the README.md which didn't work with Github anyways, and furthermore made our Github page less beautiful in dark mode.

This PR removes those tracking pixels.

  1. We also used a non-transparent jpg file format for the PANDA_sitting image. In dark mode, this resulted in less than desirable white borders around our logo.

This PR removes the jpg image, and updates it with a transparent png.

  1. We attempted to use the PANDA_sitting image as a hyperlink to https://redpanda.com/redpanda, but due to formatting clicking this would only take you to the Github object for the image.

This PR fixes the hyperlink and clicking the image will now re-direct you to our website correctly!

Backports Required

  • none - not a bug fix
  • none - this is a backport
  • none - issue does not exist in previous branches
  • none - papercut/not impactful enough to backport
  • v23.3.x
  • v23.2.x

Release Notes

Improvements

  • Making the Redpanda README.md more beautiful and functional!

README.md Outdated
[<p align="center"><img src="docs/PANDA_sitting.jpg" alt="redpanda sitting" width="400"/></p>](https://redpanda.com/redpanda)
<img src="https://static.scarf.sh/a.png?x-pxid=3c187215-e862-4b67-8057-45aa9a779055" />
<img src="https://www.google-analytics.com/collect?v=2&tid=G-G8V239NH6H&cid=555&t=event&en=page_view&dp=redpanda-data%2Fredpanda&dt=Redpanda%20GitHub" />
[<p align="center"><img src="docs/PANDA_sitting.png" alt="redpanda sitting" width="400"/></p>](https://redpanda.com/redpanda)
Copy link
Member

Choose a reason for hiding this comment

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

despite them not working because of caching, did we find out if this were unused and we could remove it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think we ever got confirmation, other than the Github Docs indicating as much.

Copy link
Member

Choose a reason for hiding this comment

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

@c4milo do you know about these trackers? i think you added the GA one? we were thinking about removing them as it's not clear they work in the readme given that github caches the tracker images.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Inspecting element in a web browser shows that the two tracking pixels are most certainly not pointing back to scarf.sh or google-analytics.com, and instead to camo.githubusercontent.com.

FWIW, the scarf tracking pixel is invisible even in dark mode, and it is the google-analytics pixel that is responsible for the visible period in the README.

Copy link
Member

Choose a reason for hiding this comment

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

yep. so the question here is not if they work/not, but if they need to be fixed or removed.

Copy link
Member

Choose a reason for hiding this comment

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

I think we need to wait for an internal resolution (slack) on this before proceeding.

@WillemKauf WillemKauf removed the request for review from emaxerrno April 12, 2024 01:15
@WillemKauf WillemKauf changed the title docs: remove tracking periods, update to transparent Redpanda logo docs: remove tracking pixels, update to transparent Redpanda logo Apr 12, 2024
From previous README source, it seems that someone was trying to create a
hyperlink to the Redpanda website using our logo. Due to formatting, this
hyperlink did not work, and clicking the image would only take you to the
Github object for the image.

This commit fixes the hyperlink, and clicking the Redpanda logo will now
take you to our platform-capabilities site.
@WillemKauf WillemKauf requested a review from c4milo April 15, 2024 19:29
Copy link
Member

@travisdowns travisdowns left a comment

Choose a reason for hiding this comment

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

Waiting for internal alignment.

Copy link
Member

@c4milo c4milo left a comment

Choose a reason for hiding this comment

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

🔥

Copy link
Member

@travisdowns travisdowns left a comment

Choose a reason for hiding this comment

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

Looks good, we can roll back if new info arrives.

@WillemKauf WillemKauf merged commit 991b8dc into redpanda-data:dev Apr 18, 2024
14 checks passed
@WillemKauf WillemKauf deleted the readme branch April 30, 2024 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants