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

chore: website structured data #677

Closed
wants to merge 1 commit into from
Closed

Conversation

hellofanny
Copy link
Contributor

What's the purpose of this pull request?

How does it work?

How to test it?

Faststore related PRs

References

Copy link

vercel bot commented Jan 31, 2025

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

Name Status Preview Updated (UTC)
starter ✅ Ready (Inspect) Visit Preview Jan 31, 2025 11:44pm

@hellofanny hellofanny changed the title chore: updates package to test chore: website structured data Jan 31, 2025
hellofanny added a commit to vtex/faststore that referenced this pull request Feb 3, 2025
## What's the purpose of this pull request?

Adds `name` and `publisher` properties to website schema

## How it works?

Allow adding the following [WebSite](https://schema.org/WebSite) schema
proprieties:

- name: website name.
- publisher: the publisher of the creative work. (We are allowing a
publisherId `@id` to identifier reference to the publisher. E.g.:
#website)

Users can add data either through the headless CMS interface or by
editing the `discovery.config.js` file.

> Note: Data from the headless CMS takes precedence over data from
`discovery.config.js`.

<img width="400" alt="image"
src="https://github.com/user-attachments/assets/42586134-1c67-4807-9c68-7aca82fe6254"
/>


## How to test it?

1. Go to
[preview](https://starter-git-test-seo-website-update-vtex.vercel.app/)
link, inspect and look for `WebSite`
<img width="877" alt="image"
src="https://github.com/user-attachments/assets/4a54bce5-a70e-46c1-a74f-5cb2f0afc3e4"
/>

2. Copy the generated script and paste
[here](https://validator.schema.org) to check if is a valid schema:

<img width="500" alt="image"
src="https://github.com/user-attachments/assets/49b33b02-305c-4478-aa4c-24d9bfd02454"
/>

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 `WebSite ` and validate the schema)

### Starters Deploy Preview

vtex-sites/starter.store#677

## References

https://developers.google.com/search/blog/2024/10/sitelinks-search-box
https://developers.google.com/search/docs/appearance/site-names#website
@hellofanny hellofanny closed this Feb 3, 2025
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.

1 participant