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

[5.1] Implement Schema.org Product type plugin #42710

Closed
wants to merge 12 commits into from
Closed

[5.1] Implement Schema.org Product type plugin #42710

wants to merge 12 commits into from

Conversation

krileon
Copy link

@krileon krileon commented Jan 25, 2024

Summary of Changes

Implements Schema.org plugin for Product type.

Testing Instructions

  1. Ensure the Product schema plugin is installed (if switching to this branch be sure to use install discovery) and published
  2. Edit any Article of your choosing in Content > Articles
  3. Under the Schema tab select "Product" Schema type
  4. Add whatever product information you would like and save the article
  5. View the article on frontend to verify product schema has been output to the head

Your schema output on frontend should be for example similar to the below, which has already been ran through schema test tools and verified (non-critical issues will be reported for missing ratings and can add support for supplying ratings if desired, but seamed weird to hardcode that in).

image

Actual result BEFORE applying this Pull Request

No Product Schema.org type available

Expected result AFTER applying this Pull Request

Product Schema.org type available

Link to documentations

Please select:

  • Documentation link for docs.joomla.org:

  • No documentation changes for docs.joomla.org needed

  • Pull Request link for manual.joomla.org:

  • No documentation changes for manual.joomla.org needed

@joomla-cms-bot joomla-cms-bot added Language Change This is for Translators PR-5.1-dev labels Jan 25, 2024
@sergeytolkachyov
Copy link
Contributor

I have tested this item ✅ successfully on 0e7b2e4

Tested it successfull. Updated from 5.0.1


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/42710.

Co-authored-by: Quy <quy@nomonkeybiz.com>
@viocassel
Copy link
Contributor

I have tested this item ✅ successfully on d704872


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/42710.

Co-authored-by: Richard Fath <richard67@users.noreply.github.com>
@richard67
Copy link
Member

@sergeytolkachyov @viocassel As this PR has received some changes, could you briefly test again? Thanks in advance.

@sergeytolkachyov
Copy link
Contributor

I have tested this item ✅ successfully on 82d2122


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/42710.

1 similar comment
@viocassel
Copy link
Contributor

I have tested this item ✅ successfully on 82d2122


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/42710.

@richard67
Copy link
Member

RTC


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/42710.

@joomla-cms-bot joomla-cms-bot added the RTC This Pull Request is Ready To Commit label Jan 31, 2024
@rdeutz
Copy link
Contributor

rdeutz commented Jan 31, 2024

We discussed this PR in the weekliy maintainers meeting and made the decsion not to merge this PR. It's not question that this Schema.org definition can be useful in some cases but this will be true for many others too. We need to draw a line what goes into core. The tools are there, we have an example how to implement this and that should be enough.

Thanks for the proposal and for working on this.

@rdeutz rdeutz closed this Jan 31, 2024
@joomla-cms-bot joomla-cms-bot removed the RTC This Pull Request is Ready To Commit label Jan 31, 2024
@krileon
Copy link
Author

krileon commented Jan 31, 2024

I don't understand what lead to your decision not to merge. At it's most basic it's just another XML form and there's nothing here to really maintain. There are a significant amount of eCommerce sites using Joomla that could massively benefit from the Product schema.

The Schema.org plugin isn't just for articles. It was designed to work with any extension. So yeah it may not make total sense adding it to an Article, but the Schema.org plugin is far more than just for that. I can't see how this is less useful than Event or JobPosting in that regard.

Are these discussions public so I can read what the concerns were?

@sergeytolkachyov
Copy link
Contributor

We discussed this PR in the weekliy maintainers meeting and made the decsion not to merge this PR. It's not question that this Schema.org definition can be useful in some cases but this will be true for many others too. We need to draw a line what goes into core. The tools are there, we have an example how to implement this and that should be enough.

Thanks for the proposal and for working on this.

Why?? On Joomla, small catalogs of goods and services are very often made using article overrides, where this plugin is simply necessary. Why can a Job or Event be included in the core, but not a Product?

@rdeutz
Copy link
Contributor

rdeutz commented Feb 1, 2024

I don't understand what lead to your decision not to merge. At it's most basic it's just another XML form and there's nothing here to really maintain. There are a significant amount of eCommerce sites using Joomla that could massively benefit from the Product schema.

The aim for production is to have lighter core. What we want to do is to give people the tools to extent Joomla! We want to have an example that people can see how they can extent the provided set of functionality. We have the Schema.org plugins and anyone can make a plugin to support what makes sense on his website.

I understand that closing a PR is frustrating for the author. But as I said we need to draw a line. I am going to ask the JED team if they can make a category for Schema.org plugins so that the work here can find a place to help others.

@brianteeman
Copy link
Contributor

If this was applied universally it would be understandable but its not

@laoneo
Copy link
Member

laoneo commented Feb 1, 2024

This plugin would be a great benefit for the JED. Please post it there and I'm sure you will get a lot of appreciation.

@SonkinS
Copy link

SonkinS commented Feb 1, 2024

Catalogs on Joomla are made very often, perhaps more often than events! For some, product support would be decisive when choosing CMS...

@krileon
Copy link
Author

krileon commented Feb 1, 2024

Features are added constantly. Schema.org feature already exists. This is simply adding 1 more XML form to it. The Schema doesn't change randomly or constantly there's nothing further to maintain here. Additionally it's a Schema.org plugin. It can be turned off or even uninstalled if someone doesn't want it.

eCommerce is important. Especially now more than ever. Drawing the line at eCommerce? This concerns me for Joomla's future to be honest. These are basic SEO features that every business should have. eCommerce capabilities are often the leading reason for someone to pick a specific CMS. Something as simple as a Product schema makes a big difference for SEO.

I cannot stress how silly decisions like this are going to continue to drive away contributors. It's as if we're beholden to a shadow council. This is an open source project. Your discussions should be public. Whether here in the ticket, the discussions section, the Joomla forums, or something similar to PHP internals. The lack of transparency is concerning.

@alikon
Copy link
Contributor

alikon commented Feb 1, 2024

from my personal point of view,
i fully agree with @laoneo

This plugin would be a great benefit for the JED. Please post it there and I'm sure you will get a lot of appreciation.

in this way your hard work would be not lost, and the whole community would benefit of it

p.s
core or not core sometimes are like "quicksand"

@laoneo
Copy link
Member

laoneo commented Feb 2, 2024

@krileon what prevents you to put the plugin into the Joomla extension directory? When you install Joomla, then it has already over 240 extensions installed. So it is normal that we maintainers want to keep that number low. You contribute it, but we maintainers need to take care of it as soon as it is merged. As we are only a handful of people, we have to be very careful what we put under our umbrella.

It is not that we do not appreciate your contribution, but we appreciate it as well when you put it into the JED.

@rdeutz
Copy link
Contributor

rdeutz commented Feb 2, 2024

A JED category for Schema Plugins is created. Thanks to the JED team for doing it so quickly!

https://extensions.joomla.org/category/core-enhancements/schema-plugins/

@krileon
Copy link
Author

krileon commented Feb 2, 2024

@krileon what prevents you to put the plugin into the Joomla extension directory?

I'm already dealing with over 30 projects and a customer base for them. All for Joomla. I've so much work to do as is I'm drowning. So if I'm to release this on my own accord I will do so through our own download channel to drive traffic to our products. I wanted to use what limited time I had and give back to Joomla instead. Now if there were maintenance to be had, which there really isn't with this plugin, then it would be spread out amongst a much larger community and isn't really an issue to be pinged in a ticket to come help.

I was hoping this was the year I'd get to seriously push some modern features into Joomla. Features that every site should have. I'm currently working on a PR for OpenGraph Metadata support in core Joomla, but from the sounds of it I just shouldn't even bother. That's the kind of message you're sending to future contributors.

I've another PR for adding Schema.org support to menu items. I suppose I should also just preemptively close that was well. You're making it very unclear where the line is to be drawn and because you discussed all of this internally not a single person that contributes has any clue why you make the decisions you make.

When you install Joomla, then it has already over 240 extensions installed. So it is normal that we maintainers want to keep that number low.

Then stop accepting new features all together if this is the argument or should I just not make this a plugin and instead hardcode in the schema type? Is the issue here features or that it's a separate extension? I just am not going to accept this as the reason to reject adding an XML file for an additional Schema type. Again, the Schema is not ever changing. There's nothing to maintain here. I would completely understand hesitance to just blindly accept a new full blown component, but this just isn't that.

Maybe another suggestion for the JED is GitHub support. Point a JED listing to a GitHub project and it can be packaged and released automatically. Then create a Joomla project for housing official-unofficial extensions that the maintenance team will have no oversite for and would be entirely community driven extensions.

You contribute it, but we maintainers need to take care of it as soon as it is merged. As we are only a handful of people, we have to be very careful what we put under our umbrella.

I would personally say the maintainers are everyone here that contributes to this project. We will be using this schema type on our very own website, which has existed since Mambo, so it will be maintained (there's nothing to maintain as it's a standardized Schema) at the very least by those that use it (us).

If you want more contributors then stop being so unaccepting of change and pushing contributors away from this project. You're creating your own loop of less and less contributors. There's a serious disconnect going on between those who want to contribute and the maintainers team.

At any rate the decision has been made and I've said my peace. Best of luck.

@sandewt
Copy link
Contributor

sandewt commented Feb 3, 2024

At any rate the decision has been made and I've said my peace. Best of luck.

Sometimes things don't go the way you would like. And that can be disappointing, especially if you see the usefulness of it and have put in the necessary time. Your contribution is greatly appreciated, given the many positive responses. With your thorough knowledge of Joomla, you can still make many valuable contributions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.