govCMS / GovCMS

Current Drupal release of the main GovCMS distribution, with releases mirrored at https://www.drupal.org/project/govcms
GNU General Public License v2.0
128 stars 40 forks source link

Add Schema.org Blueprints module to GovCMS #1042

Open rebelmusic opened 4 months ago

rebelmusic commented 4 months ago

** What value does this module/package add to GovCMS?

Allows GovCMS sites to take a Schema.org-first approach to building content models and structured data in Drupal that is standardized, easy-to-understand, and maintainable. It can eventually become a replacement for the Metatag module as it's more powerful.

** Is the module Drupal 10 compatible?

Yes.

** Please provide a brief outline of what this module does.

The Schema.org Blueprints module uses the public Schema.org specification to create content types, fields/properties, and relationships that machines, developers, and search engines understand.

** Who does this module benefit: [X] end users - Search engines can better understand the sites's structured data and display it in search results [X] site builders - Can implement it via the UI [X] developers - Can implement it in various ways

** How could you provide/replicate the functionality of this module using alternative methods, eg in your theme?

Currently, you can use the Metatag module. The project maintainer of Metatag has suggested to use the more powerful Schema.org Blueprints module in the future.

** If this module styles or alters HTML or JavaScript output, can the functionality be provided via the theme? What alternatives have you considered.

n/a

** What is the maintenance and support status of the module. Describe the issue queue activity.

Currently 56 sites are using this...soon to be 57 :)

The module is written by the guy that wrote the Webform module jrockowitz.

There is currently 1 supporting organisation.

Currently 12 open issues.

The module is relatively new and in alpha release, but in my personal opinion, it's expected to become stable and popular in due time.

** What permissions are needed to utilise the module (and are any new permissions provided by the module)?

The module will come with some permissions that can be configured.

** Does the module modify the database structure and/or store additional metadata on nodes or other entities? If so, why? What are the risks for future updates?

Yes, the module stores structured data that you can define on a per entity basis.

The current risk - No update hooks will be provided between alpha releases. More info about this on the module's page. It's expected this is short term until a stable release comes out.

** Is the module designed to capture anonymous user data?

No...unless you use an entity field that has anonymous user entered data.

** Is the output of the module typically fully cacheable? Would the inclusion of this module potentially render pages uncacheable.

I am not 100% sure at this point, but the structured data (which will be in the html source) should be cacheable.

** What is your assessment of the quality of this module, the contribution history of the module's maintainers, and the uptake of the module within the Drupal community?

The quality seems solid (written by the same person who wrote the Webform module). I have been tested it out on another non-GovCMS site and its pretty fascinating and seems to be the way forward (instead of the Metatag module).

It seems this module will pick up in popularity. It's already recommended by project maintainer of Metatag module

** Additional information

Please see this Youtube video for a short overview of this module:

https://www.youtube.com/watch?v=XkZP6QjJkWs&feature=youtu.be

thisisalistairsaccount commented 3 months ago

Hi @rebelmusic thanks for the submission. I think the module you've mentioned here is this one: https://www.drupal.org/project/schemadotorg

At the moment, the module is not yet stable, but of course if the interest picks up more broadly and from our community and we get stable on it as well, we're happy to consider it in the future.

Currently, you can use the Metatag module. The project maintainer of Metatag has suggested to use the more powerful Schema.org Blueprints module in the future.

I get the impression the project maintainer's suggestion here is to Schema.org Blueprints in lieu of Schema.org Metatag (https://www.drupal.org/project/schema_metatag) rather than replace the Metatag module. At least that's what I'm getting when I read the linked article, happy to be corrected if I've missed something. It does like Metatag will have a 3.0.0 release at some point based on https://www.drupal.org/project/metatag/issues/3423894