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 meta description, OpenGraph and/or Twitter cards for better visibility in search engines #236

Closed
msbt opened this issue Jan 7, 2021 · 2 comments

Comments

@msbt
Copy link
Collaborator

msbt commented Jan 7, 2021

As suggested here, the SEO of our docs could do with a little improvement. Apparently the og stuff doesn't work out of the box, that's why the build process needs an update:

For OpenGraph, there's a Sphinx extension.

The meta description could/should be added like this via RST: https://docs.readthedocs.io/en/stable/guides/technical-docs-seo-guide.html#use-meta-tags

On the main website we use this as our default image for og/meta/twitter cards: https://crate.io/wp-content/uploads/2020/10/crateio-logo.png

@amotl
Copy link
Member

amotl commented May 25, 2021

On the main website we use this as our default image for og/meta/twitter cards: https://crate.io/wp-content/uploads/2020/10/crateio-logo.png

Can we also upload/use a logo variant with dimensions 320x168x72 somehow?

image

@amotl
Copy link
Member

amotl commented May 25, 2021

Hi Matthias,

#269 adds and activates the Sphinx extension sphinxext-opengraph to generate OpenGraph metadata (https://ogp.me/).

With kind regards,
Andreas.

@amotl amotl closed this as completed May 26, 2021
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

No branches or pull requests

2 participants