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

Use property attribute for OpenGraph title and image #3213

Merged
merged 19 commits into from
Oct 24, 2023

Conversation

obiwanpelosi
Copy link
Contributor

Fixes

Fixes #3211 by @sarayourfriend

Description

Change OpenGraph tags for title, description, and image from using a name attribute to using a property attribute instead.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@obiwanpelosi obiwanpelosi requested a review from a team as a code owner October 17, 2023 09:30
@openverse-bot openverse-bot added 🟩 priority: low Low priority and doesn't need to be rushed 🛠 goal: fix Bug fix 🕹 aspect: interface Concerns end-users' experience with the software 🧱 stack: frontend Related to the Nuxt frontend labels Oct 17, 2023
Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

Thanks for contributing to the issue @RogueCode007! There are some changes required to make the code work properly. Additionally, after making these changes, you will need to update the tests.

import type { MetaPropertyName } from "vue-meta/types/vue-meta"
import type { MetaPropertyProperty } from "vue-meta/types/vue-meta"
Copy link
Member

Choose a reason for hiding this comment

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

These types are imported from the vue-meta package and must use the name set by that package. Please revert this change.

name: "robots",
property: "robots",
Copy link
Member

Choose a reason for hiding this comment

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

The robots meta tag must use name and content. Please revert this change.

Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

@RogueCode007, og.ts only creates the meta for single result pages (single image and single audio).
To change the meta for other pages, you'll need to update these lines:

{ hid: "og:title", name: "og:title", content: "Openverse" },
{
hid: "og:image",
name: "og:image",
content: "/openverse-default.jpg",

@obiwanpelosi
Copy link
Contributor Author

@RogueCode007, og.ts only creates the meta for single result pages (single image and single audio). To change the meta for other pages, you'll need to update these lines:

{ hid: "og:title", name: "og:title", content: "Openverse" },
{
hid: "og:image",
name: "og:image",
content: "/openverse-default.jpg",

ah thanks! i was wondering what was wrong

@RogueCode007, og.ts only creates the meta for single result pages (single image and single audio). To change the meta for other pages, you'll need to update these lines:

{ hid: "og:title", name: "og:title", content: "Openverse" },
{
hid: "og:image",
name: "og:image",
content: "/openverse-default.jpg",

Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Awesome work, @RogueCode007 ! Thank you for your contribution 🎉

@obulat obulat requested a review from dhruvkb October 20, 2023 06:47
Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

All good, LGTM. Tested locally and everything works. Thanks for the contribution @RogueCode007!

@dhruvkb dhruvkb changed the title Change OpenGraph tags for title, description, and image tags from using a name attribute to using a property attribute instead Use property attribute for OpenGraph title and image Oct 24, 2023
@dhruvkb dhruvkb merged commit 0987949 into WordPress:main Oct 24, 2023
42 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🕹 aspect: interface Concerns end-users' experience with the software 🛠 goal: fix Bug fix 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

name incorrectly used instead of property for OpenGraph tags
4 participants