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

Add JSON-LD for EIPS #2796

Merged
merged 2 commits into from
Jul 21, 2020
Merged

Add JSON-LD for EIPS #2796

merged 2 commits into from
Jul 21, 2020

Conversation

fulldecent
Copy link
Contributor

Extracted from PR at #2738

"@context": "http://schema.org",
"@type": "Article",
"author": "{% include authorlist.html authors=page.author %}",
"name": "EIP-{{ page.eip | xml_escape }}: {{ page.title | xml_escape }}{% if page.status == "Draft" or page.status = "Last Call" %} [DRAFT]{% endif %}",
Copy link
Contributor

Choose a reason for hiding this comment

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

From CI:

Liquid Warning: Liquid syntax error (line 50): Unexpected character = in "page.status == "Draft" or page.status = "Last Call"" in /_layouts/eip.html

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Corrected at b929e3d

@MicahZoltu
Copy link
Contributor

Same comment as in #2738. You should get this added to the next EIPIP meeting agenda since it is a meta change.

@fulldecent
Copy link
Contributor Author

EIPIP is not authoritative and does not have decision makers. Therefore it is ineffectual and that is why I left.

This current matter affects nobody, it is merely a HTML coding update, I believe it can be accepted with input only by a single person with commit access rather than requiring votes, socializing or other consensus measures.

@MicahZoltu
Copy link
Contributor

Took another gander at this one and think it is fine.

@MicahZoltu MicahZoltu merged commit b610d64 into ethereum:master Jul 21, 2020
@fulldecent
Copy link
Contributor Author

Cool, thank you

@fulldecent fulldecent deleted the patch-70 branch July 21, 2020 03:05
@fulldecent
Copy link
Contributor Author

Related: #2811

@@ -42,3 +42,22 @@ <h1 class="page-heading">
{{ content }}

</div>
{% comment %}
Article schema specification:
https://schema.org/Article
Copy link
Member

Choose a reason for hiding this comment

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

I wonder why was my comment about the schema ignored in the old PR: #2738 (comment)

I suggested TechArticle with more fields.

See schema.org for the distinction:

TechArticle
Thing > CreativeWork > Article > TechArticle
A technical article - Example: How-to (task) topics, step-by-step, procedural troubleshooting, specifications, etc.

vs.

Article
Thing > CreativeWork > Article
An article, such as a news article or piece of investigative report. Newspapers and magazines have articles of many different types and this is intended to cover them all.

See also blog post.

I do not think EIPs should be considered as blog posts or news articles.

@axic
Copy link
Member

axic commented Jul 21, 2020

Also as mentioned in #2738 (comment) this PR added the JSON+LD as a duplicate entry, given it already exists in _includes/head.html.

@axic
Copy link
Member

axic commented Jul 21, 2020

Google's testing tool displays errors:

Screenshot 2020-07-21 at 15 56 23

Can we be a bit more prudent about merging PRs?

@fulldecent
Copy link
Contributor Author

@axic The JSON-LD in the head is NOT a conflict against this new JSON. The former regards the website a whole (WebSite) and the latter regards individual EIPs (Article or subclass).

@fulldecent
Copy link
Contributor Author

@axic The Google tool shows errors. And that is fine. We do not currently require images for each EIP and I do not expect that to change soon.

Either way, I believe life is better with this PR merged and if images will be added then that can be considered separately.

SEO was an overarching concern for the EIPs project and this PR is aligned with that goal.

@fulldecent
Copy link
Contributor Author

@axic Regarding TechArticle as more appropriate than Article. This is a good point, thank you. I support that change here: #2814

@MicahZoltu
Copy link
Contributor

Can we be a bit more prudent about merging PRs?

I contend that this PR was an improvement, thus worth merging. It added JSON-LD content that improved SEO. I believe the errors/warnings are just "you can do better" things, and not all of them are possible for us to address (like the image tag, and probably publisher tag).

That being said, it would be nice to get the rest added like headline (EIP title), datePublished (same as created), dateModified (ideally the commit timestamp of the last commit to touch the EIP, but if not just datePublished perhaps), mainEntityOfPage (I'm not sure what this is, but presumably we have one!).

@fulldecent
Copy link
Contributor Author

fulldecent commented Jul 21, 2020

Other items in this PR -> #2816

Probably Google is flagging as "error" when warning is appropriate. But still, it's Google, and I used to work there, so --\_0_/-- #2816

tkstanczak pushed a commit to tkstanczak/EIPs that referenced this pull request Nov 7, 2020
* Add JSON-LD for EIPS

* Update eip.html
Arachnid pushed a commit to Arachnid/EIPs that referenced this pull request Mar 6, 2021
* Add JSON-LD for EIPS

* Update eip.html
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.

3 participants