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

Set schema_metatag global defaults for az_quickstart Using the az_seo Module #3644

Open
4 tasks
RyanDool opened this issue Aug 15, 2024 · 1 comment · May be fixed by #3743 or #3901
Open
4 tasks

Set schema_metatag global defaults for az_quickstart Using the az_seo Module #3644

RyanDool opened this issue Aug 15, 2024 · 1 comment · May be fixed by #3743 or #3901
Assignees
Labels
enhancement New feature or request

Comments

@RyanDool
Copy link
Contributor

RyanDool commented Aug 15, 2024

Motivation

To ensure consistent and accurate schema.org metadata across all subdomains under arizona.edu, global defaults for schema.org CollegeOrUniversity should be set. These defaults can apply to standalone pages or work in conjunction with additional schema on specific content types.

The relevant schema type is CollegeOrUniversity, which allows for structured data representation of educational institutions and their departments or colleges.

Example JSON-LD output:

##College or University
This could be applied to any [subdomain].arizona.edu page, either stand alone or in conjunction with additional schema.
https://schema.org/EducationalOrganization

<script type="application/ld+json">
{
	"@context": "https://schema.org/",
	"@type": "CollegeOrUniversity",
	"name": "University of Arizona {{Department/College}}",
	"url": "{{Department/College url}}",
	"description": "{{Description of department/college}}",
	"logo": "{{Department/College logo}}",
	"image": "{{Image to represent department/college}}",
	"sameAs": "{{comma separated social media URLs}}",
	"address": {
		"@type": "PostalAddress",
		"streetAddress": "{{Street Address}}",
		"addressLocality": "{{City}}",
		"addressRegion": "{{2 letter state abbreviation}}",
		"postalCode": "{{5 digits}}",
		"addressCountry": "{{Country abbreviation}}"
	},
	"telephone": "{{+1-555-555-5555}}",
	"email": "{{Department/College email address}}",
	"parentOrganization": {
		"@type": "EducationalOrganization",
		"name": "University of Arizona",
		"url": "https://www.arizona.edu/",
		"address": {
			"@type": "PostalAddress",
			"streetAddress": "1401 E University Blvd",
			"addressLocality": "Tucson",
			"addressRegion": "AZ",
			"postalCode": "85721",
			"addressCountry": "US"
		}
	}
}
</script>

Is your feature request related to a problem? Please describe.

Currently, subdomains under arizona.edu lack consistent schema.org metadata defaults, which can negatively impact search engine optimization and visibility. Applying CollegeOrUniversity schema globally ensures a consistent baseline for all pages.


Proposed Resolution

Describe the Solution You’d Like

  • Set global schema_metatag defaults in the az_seo module for the az_quickstart installation.
  • The defaults should include the CollegeOrUniversity schema type with fields that can either:
    • Use static default values for the main organization (e.g., University of Arizona).
    • Be overridden dynamically for specific departments or colleges.

Suggested Field Mapping

  • name: Default to University of Arizona or use department/college name when provided.
  • url: Default to the canonical URL of the site or subdomain.
  • description: Map to a site-wide description field or default to a generic description.
  • logo: Use the site logo or a default logo.
  • image: Use an image representing the site or institution.
  • sameAs: Map to a list of social media URLs provided in site settings.
  • address: Populate address fields dynamically or use defaults:
    • streetAddress: "1401 E University Blvd".
    • addressLocality: "Tucson".
    • addressRegion: "AZ".
    • postalCode: "85721".
    • addressCountry: "US".
  • telephone: Allow site administrators to specify a contact number.
  • email: Allow site administrators to specify a contact email.
  • parentOrganization: Static values:
    • "name": "University of Arizona".
    • "url": "https://www.arizona.edu".

Additional Context

Roles and Permissions Considerations

Anonymous User

  • No impact: Schema metatags are not user-editable and only impact site metadata.

Authenticated User

  • No impact.

Content Editor

  • Gains the ability to review and modify global schema fields through UI (if made editable).

Content Administrator

  • Gains the ability to manage and configure global schema defaults through az_seo module settings.

Administrator

  • Gains full control over enabling/disabling global schema metatag defaults for the entire site.

Additional Context

  • This issue complements other schema.org implementations, such as those for specific content types (e.g., az_person, az_course).
  • Global defaults should provide a foundation while allowing for overrides in specific contexts.

Conditions of Satisfaction

  • schema_metatag global defaults for CollegeOrUniversity are implemented using the az_seo module and schema_organization sub module.
  • Metatag fields are populated dynamically or with static defaults as appropriate.
  • The generated JSON-LD matches the schema.org CollegeOrUniversity specification.
  • Permissions are configured to allow appropriate roles to manage schema metatags.

Next Steps

  1. Configure global defaults in the az_seo module.
  2. Test schema output on subdomains and standalone pages.
  3. Document any configuration or editing instructions for site administrators.
@RyanDool
Copy link
Contributor Author

@mrbeiley This is the feature request we discussed

@mrbeiley mrbeiley self-assigned this Aug 15, 2024
@joeparsons joeparsons added the enhancement New feature or request label Sep 13, 2024
@mrbeiley mrbeiley linked a pull request Sep 26, 2024 that will close this issue
32 tasks
@mrbeiley mrbeiley linked a pull request Sep 26, 2024 that will close this issue
32 tasks
@danahertzberg danahertzberg moved this from Todo to In Progress in 2.12.x Patch Release Issues Oct 30, 2024
@joeparsons joeparsons linked a pull request Nov 21, 2024 that will close this issue
32 tasks
@trackleft trackleft changed the title Schema.org Metatag "CollegeOrUniversity" Set schema_metatag global defaults for az_quickstart Using the az_seo Module Nov 21, 2024
@joeparsons joeparsons linked a pull request Nov 21, 2024 that will close this issue
32 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: In Progress
3 participants