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

Added a text whereby using the embedded manifest is RECOMMENDED. #412

Merged
merged 3 commits into from
Mar 19, 2019

Conversation

iherman
Copy link
Member

@iherman iherman commented Mar 19, 2019

@mattgarrish
Copy link
Member

Generally looks fine to me. I just made a couple of minor editorial tweaks to put the recommended practice first (emphasize what we want people to do) and to shorten the note.

@iherman
Copy link
Member Author

iherman commented Mar 19, 2019

Embedding is the preferred option as search engines will only process schema.org metadata in JSON-LD format when it is embedded in an HTML page.

May not be o.k. This makes a general statement on all search engines, which we cannot be sure is the case. Well, we know that this is what Google does (ie, does not), but on long term we cannot be sure and maybe, say, Yandex is more flexible.

What about a will->may, like:

Embedding is the preferred option as search engines may only process schema.org metadata in JSON-LD format when it is embedded in an HTML page.

@mattgarrish
Copy link
Member

I actually took "may" out to avoid an rfc keyword in a note. :)

What about "typically" or "usually" or something along those lines rather than "may"?

@iherman
Copy link
Member Author

iherman commented Mar 19, 2019

Is it a problem with 'may', as opposed to 'MAY'? I do not think so... let alone the fact that this is a note, ie, informal anyway...

@mattgarrish
Copy link
Member

Well, yes, we should avoid keywords in informative content. Relying on uppercase to determine what is a keyword isn't terribly accessible.

It also adds confusion about whether we intended to make a normative statement, IMO, even if in this case it would be outside the scope of the spec.

In these cases, "might" can usually be dropped in instead with no impact on the meaning.

@iherman
Copy link
Member Author

iherman commented Mar 19, 2019

So... can we use

Embedding is the preferred option as search engines might only process schema.org metadata in JSON-LD format when it is embedded in an HTML page.

I made a new commit accordingly.

@mattgarrish mattgarrish merged commit db67738 into master Mar 19, 2019
@mattgarrish mattgarrish deleted the issue-327-embedded-manifests branch March 19, 2019 20:15
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.

2 participants