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

Upload and update global opengraph image, and create a opengraph description override for homepage #6696

Merged
merged 17 commits into from
Dec 13, 2024

Conversation

Alan-eMartin
Copy link
Contributor

@Alan-eMartin Alan-eMartin commented Dec 10, 2024

Context:

This pull request introduces enhancements to the documentation site's SEO by adding a custom Open Graph image and description for the homepage. These changes ensure better visibility and presentation when the site is shared on social platforms or link previews.

Description of the Change:

  • New Open Graph Image: Uploaded opengraph.png for consistent branding across social platforms.
  • Global Open Graph Update: Updated the global opengraph image source to reference the new image.
  • Homepage Title & Description Override: Added an og:description override in index.rst to provide a custom meta og:description for the homepage.

Benefits:

  • Improved SEO

Possible Drawbacks:

  • N/A

Related GitHub Issues:

  • N/A

@Alan-eMartin Alan-eMartin marked this pull request as ready for review December 10, 2024 20:21
Copy link

codecov bot commented Dec 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.62%. Comparing base (2bb567a) to head (a004afe).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #6696   +/-   ##
=======================================
  Coverage   99.62%   99.62%           
=======================================
  Files         474      474           
  Lines       44617    44628   +11     
=======================================
+ Hits        44448    44459   +11     
  Misses        169      169           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@ashishks0522 ashishks0522 left a comment

Choose a reason for hiding this comment

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

Can confirm works as expected! Thanks @Alan-eMartin

Screenshot 2024-12-10 at 4 11 10 PM

Copy link
Contributor

@mudit2812 mudit2812 left a comment

Choose a reason for hiding this comment

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

Looks awesome!

Copy link
Contributor

@justinpickering justinpickering left a comment

Choose a reason for hiding this comment

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

Nice @Alan-eMartin ! 👍 💯

@Alan-eMartin Alan-eMartin merged commit ff3c1f9 into master Dec 13, 2024
46 checks passed
@Alan-eMartin Alan-eMartin deleted the update-og-image-and-desc branch December 13, 2024 23:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants