feat: Adding organization structured data json

[hellofanny]

What's the purpose of this pull request?

• Adding Organization structured data in homepage

Adding organization structured data to your home page can help Google better understand your organization's administrative details and disambiguate your organization in search results.

How it works?

Allow adding the following Organization schema proprieties:

• url: the URL of the website of your organization. This helps Google uniquely identify your organization.
• sameAs: The URL of a page on another website with additional information about your organization, if applicable. For example, a URL to your organization's profile page on a social media or review site. You can provide multiple sameAs URLs.
• logo: A logo url that is representative of your organization, if applicable. (image guidelines)
• image: An image that is representative of your organization. This could also be the same as the logo. Add a ImageObject (provide image url and caption)
• name: The name of your organization.
• legalName: The registered, legal name of your Organization.
• email: The email address to contact your business, if applicable.
• telephone: A business phone number meant to be the primary contact method for customers, if applicable.
• address: The address (physical or mailing) of your organization, if applicable.

Note: Users can add Organization data through the headless CMS interface.

Headless CMS

TODO: Run cms sync in default acc.

How to test it?

1. Go to preview link, inspect and look for Organization

2. Copy the generated script and paste here - google rich test to test the valid schema:

OR

1. Test in storeframework account, go to CMS admin, changes the fields values -> Save and Publish.
2. Wait for the new preview link and do the same process mention above (look for organization and validate the schema)

Starters Deploy Preview

vtex-sites/starter.store#655

References

• Google rich test
• Schema.org

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
faststore-site	✅ Ready (Inspect)	Visit Preview	Feb 1, 2025 0:14am

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

[lariciamota]

question: what is this id?

[hellofanny]

The id serves as a reference key, allowing us to use it elsewhere in our structured data. Our client has listed it as a required attribute, as they seem to rely on it frequently.

Maybe I should update this description 🙇

There is this link for reference.

[lariciamota]

question: I'm wondering, since it's already configurable in the hCMS, why add it also on the discovery.config? I understand there are already some SEO config on this file and on hCMS, but I started to wonder about it now because it's a lot of data and we are about to add more SEO data in upcoming PRs. So I'd like to hear what you thought about it, and if I'm missing something

[hellofanny]

Nice question! I just added it to follow the pattern, keeping it in both places and allowing customization via hCMS and code. However, I feel like we're adding more and more attributes. Maybe it would be better to create a separate file just for handling SEO configuration, or we could keep these "extra" settings in hCMS instead.

[lariciamota]

Yeah!! Could you open a thread on our channel so everyone can discuss those approaches? 🙏

[hellofanny]

We've discussed as a team, and decided to keep particular page's SEO configurations only in the hCMS.