-
-
Notifications
You must be signed in to change notification settings - Fork 88
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
Consider adding OpenGraph meta data #529
Comments
It' definitly worth adding OpenGraph meta data. Thanks for the hint!
So from my point of view this extension is interesting, but does not fit enough to the needs of training.plone.org |
Two more thougts about OpenGraph meta data: Apart from the fact that it would be handsome to write
and get og:description from above html_meta description generated, the author can write
The other point that i think is worth mentioning: does anybody want to twitter a training chapter? yes, they are hot stuff, but will they be twittered? |
This is by design. It does integrate with
See related issue.
I had not thought of doing that. That's a great solution! Let's do this instead.
Twitter, Facebook, and other social media that Plone Foundation uses. There is also an auto-post to Slack. I also just asked to auto-post to Discord. I think it would be useful. We've been looking for content to announce, and I can't think of anything more important to announce than Training documentation, except conferences. |
To summarize next steps, I would suggest that we start including the following OG meta information:
I understand that that will lead to some duplication of meta tags, but I think it is worth it for better search results and social media posts. |
What I mean with #529 (comment) is:
Now I wonder how to achieve, that every chapter even gets the additional "property=og:description": "OpenGraph description". Ideally this og:description would be generated by a plugin from --- html_meta: "description": "description" without the need that an author has to add it like:
|
I played a little bit with the extension sphinxext-opengraph.
is added to a file, the explicit og:description is prioritized before the generated value from the plugin. That's good and allows to use the plugin. So if a script adds a snippet
to every file, the authors just have to fill in text. A downside (but valuable) is, that the build throws warnings for every empty html_meta attribute. See the branch https://github.com/plone/training/tree/sphinxext-opengraph with a script that adds the empty html_meta snippet. So +1 from me for using the plugin together with added html_meta section for every file. |
Nice work! I'd like to see a few more default meta tags. These are considered "basic" and should be included. Per page:
In ogp_image = "../_static/logo.png" # does this actually resolve to a fully qualified URL?
ogp_type = "website" I think your script could be incorporated into the https://github.com/pypa/warehouse/blob/main/Makefile#L14-L35 One final note, in |
See https://github.com/wpilibsuite/sphinxext-opengraph
The text was updated successfully, but these errors were encountered: