Installation Guide

Last updated on
7 August 2023

The Schema.org Blueprints module and sub-modules should be installed as you would install a contributed Drupal module.  

It’s essential to understand that the Schema.org Blueprints module provides a set of tools to create perfect data structures (Schema.org), pristine APIs (JSON:API), and great SEO (JSON-LD) within the best content authoring and administration user experience. 

To achieve these goals, the Schema.org Blueprints module includes a lot of sub-modules and APIs that provide features, enhancements, and integrations using a composable modular architecture. Before getting started, you should understand what Schema.org is and how to compose a Drupal website. This core understanding allows you to explore using the Schema.org Blueprints module, and to create and manage a content model and architecture that is standardized and understandable by people, machines, and search engines.

Invest the time necessary to understand that each sub-module provides a feature, integration, or enhancement built on top of the main Schema.org Blueprints module. For example, the main module integrates Schema.org's schemas and provides services to create entity types and fields. However, you need to install the Schema.org Blueprints UI to generate mappings, entity types, and fields using Drupal's administrative UI. You should also install the report, mapping set, and export modules to help your content architects fully understand Schema.org, and plan your organization's content models. Depending on how you want to build your Drupal application, you must also decide whether to install the taxonomy, media, paragraphs, layout, metatag, and translation support and integration modules.  

Building a great and maintainable Drupal application is a complex and sometimes overwhelming task. The Schema.org Blueprints module is a tool to help your organization build and maintain a standardized and easy-to-understand content model within an excellent content administration and authoring experience.

Please, take your time to understand the Schema.org Blueprints module, and please don't be afraid to ask questions and share your feedback.

Below are some prerequisites, recommendations, installation, and configuration tips.

Prerequisites

Recommendations

Installation

  • The Schema.org Blueprints module consists of a core module with a few dozen sub-modules.
  • When building entity types, most sub-modules should be enabled on development servers.
  • Review the MODULES.md file, which lists different groups of modules that should be installed to assist with the initial creation of Schema.org types with other enhancements.
  • In production, only a few modules are required. For example, the Schema.org Blueprints JSON-LD module needs to be enabled for SEO.

Configuration

  • The Schema.org Blueprints module ships with a reasonable default configuration, however everything is customizable and configurable.
  • Review all Schema.org Blueprint configuration settings.
  • Module-specific settings are grouped together.
  • Configuration can be edited via the UI and exported YAML file.

Help improve this page

Page status: No known problems

You can: