Skip to content

Add JSON-ID elements to pages.#2

Merged
MrHinsh merged 3 commits into
mainfrom
JSON-LD
Jun 11, 2025
Merged

Add JSON-ID elements to pages.#2
MrHinsh merged 3 commits into
mainfrom
JSON-LD

Conversation

@MrHinsh
Copy link
Copy Markdown
Collaborator

@MrHinsh MrHinsh commented Jun 11, 2025

This pull request introduces significant enhancements to the website's metadata and structured data by implementing JSON-LD schemas and enriching individual creator profiles. The changes aim to improve search engine optimization (SEO), provide richer content for search engines, and enhance the user experience with more detailed creator information.

Enhancements to metadata and structured data:

  • JSON-LD Schema Implementation:
    • Added JSON-LD support for WebSite, WebPage, CreativeWork, and Person schema types to improve structured data for search engines. (site/layouts/partials/JSON-LD/main.html, site/layouts/partials/JSON-LD/website.html, site/layouts/partials/JSON-LD/webpage.html, site/layouts/partials/JSON-LD/creativework.html, site/layouts/partials/JSON-LD/person.html) [1] [2] [3] [4] [5]
    • Integrated the JSON-LD partial into the base layout to ensure it is included on all pages. (site/layouts/_default/baseof.html)

Enrichment of creator profiles:

  • Expanded Creator Metadata:
    • Added new metadata fields such as jobTitle, worksFor, alumniOf, knowsAbout, creator, awards, and author for individual creator pages. This provides more detailed information about creators like Jeff Sutherland, John Coleman, and Ralph Jocham. (site/content/creators/jeff-sutherland/index.md, site/content/creators/john-coleman/index.md, site/content/creators/ralph-jocham/index.md) [1] [2] [3]

Content updates:

  • Refinement of Guide Metadata:
    • Simplified the keywords field for the Scrum Guide Expansion Pack to focus on modern Scrum and related topics. (site/content/guide/index.md)

These updates collectively enhance the site's discoverability, provide richer context for search engines, and improve the presentation of creator profiles.

MrHinsh added 2 commits June 11, 2025 13:29
- enhance creator profiles with JSON-LD schema for better SEO
- include additional fields like jobTitle, worksFor, and knowsAbout

✨ feat(layout): integrate JSON-LD structured data across site

- add JSON-LD templates for different page types: CreativeWork, Person, WebPage, WebSite
- implement partials to dynamically generate appropriate JSON-LD based on page type

💄 style(baseof): add JSON-LD partial inclusion in base layout

- include JSON-LD main partial to load appropriate schema for each page
- restructure keywords list for better readability and relevance
- include modern Scrum and Product Management in keywords

♻️ refactor(JSON-LD): improve JSON-LD structure and keyword handling

- fix indentation and formatting issues in JSON-LD templates
- update author URL handling to use $creator.Permalink
- enhance keyword handling by dynamically generating JSON-LD "about" section
- modify "keywords" field to use "delimit" for better formatting

♻️ refactor(person): enhance contributor section with dynamic data

- add dynamic fetching of guide page for better integration
- include guide title and description in the contributor section
@MrHinsh MrHinsh self-assigned this Jun 11, 2025
@github-actions
Copy link
Copy Markdown

Azure Static Web Apps: Your stage site is ready! Visit it here: https://agreeable-island-0c966e810-2.centralus.6.azurestaticapps.net

@MrHinsh MrHinsh requested a review from Copilot June 11, 2025 12:47
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces JSON-LD structured data support across the site and enriches creator profiles with additional metadata.

  • Implements WebSite, WebPage, CreativeWork, and Person JSON-LD schemas via Hugo partials
  • Integrates the JSON-LD main wrapper into the base layout to include structured data on every page
  • Refactors guide keywords into a YAML list and expands frontmatter fields for creator profiles

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
site/layouts/partials/JSON-LD/website.html Added WebSite schema partial
site/layouts/partials/JSON-LD/webpage.html Added WebPage schema partial
site/layouts/partials/JSON-LD/person.html Added Person schema partial
site/layouts/partials/JSON-LD/creativework.html Added CreativeWork schema partial
site/layouts/partials/JSON-LD/main.html Wrapper logic to select appropriate schema
site/layouts/_default/baseof.html Included JSON-LD main partial in base layout
site/content/guide/index.md Converted keywords to a YAML list
site/content/creators/jeff-sutherland/index.md Expanded frontmatter with jobTitle, worksFor, etc.
site/content/creators/john-coleman/index.md Expanded frontmatter with worksFor, knowsAbout, etc.
site/content/creators/ralph-jocham/index.md Expanded frontmatter with jobTitle, knowsAbout, etc.
Comments suppressed due to low confidence (4)

site/layouts/partials/JSON-LD/website.html:10

  • Wrap $siteURL in quotes to emit a valid JSON string, e.g., "url": "{{ $siteURL }}".
"url": {{ $siteURL }},

site/layouts/partials/JSON-LD/webpage.html:11

  • Enclose $pageURL in quotes for valid JSON output, e.g., "url": "{{ $pageURL }}".
"url": {{ $pageURL }},

site/layouts/partials/JSON-LD/person.html:14

  • Enclose $pageURL in quotes to produce valid JSON, for example "url": "{{ $pageURL }}".
"url": {{ $pageURL }},

site/layouts/partials/JSON-LD/creativework.html:11

  • Wrap the page URL in quotes—"url": "{{ $pageURL }}"—to maintain valid JSON-LD.
"url": {{ $pageURL }},

Comment thread site/content/creators/ralph-jocham/index.md
Comment thread site/content/creators/john-coleman/index.md
Comment thread site/content/creators/ralph-jocham/index.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@MrHinsh MrHinsh added the enhancement New feature or request label Jun 11, 2025
@github-actions
Copy link
Copy Markdown

Azure Static Web Apps: Your stage site is ready! Visit it here: https://agreeable-island-0c966e810-2.centralus.6.azurestaticapps.net

@MrHinsh MrHinsh merged commit 2b7a93c into main Jun 11, 2025
4 checks passed
@MrHinsh MrHinsh deleted the JSON-LD branch June 11, 2025 16:37
MrHinsh pushed a commit that referenced this pull request Oct 15, 2025
MrHinsh added a commit that referenced this pull request Jan 21, 2026
This pull request introduces significant improvements to documentation
and styling for blockquotes, callouts, and diagrams, enhancing both
usability and visual clarity. The most important changes include
comprehensive guidance for using blockquotes and alert-style callouts,
detailed instructions and best practices for Mermaid.js diagrams, and
new CSS styles for blockquotes and highlights. Additionally, the
operating models guide now uses callouts to emphasize key concepts, and
minor visual improvements are made for footnote references and headings.

**Documentation Enhancements**

* Added detailed sections to `docs/content-management.md` and
`docs/contributing.md` explaining how to use standard blockquotes and
GitHub-flavored alert-style callouts, including available types, syntax,
usage guidelines, and best practices.
[[1]](diffhunk://#diff-2ac4893aa0491d153ceea4eea80736120d2b356f801faf00ccd79151f38b9758R68-R239)
[[2]](diffhunk://#diff-419d79ae7d440d49b3fa5fa7739f5f3a359e3ca42c3fa942e5604ae3474eb35bR189-R266)
* Provided comprehensive instructions for enabling and using Mermaid.js
diagrams in documentation, including supported types, syntax examples,
and best practices for accessibility and performance.
[[1]](diffhunk://#diff-2ac4893aa0491d153ceea4eea80736120d2b356f801faf00ccd79151f38b9758R68-R239)
[[2]](diffhunk://#diff-419d79ae7d440d49b3fa5fa7739f5f3a359e3ca42c3fa942e5604ae3474eb35bR189-R266)

**Styling Improvements**

* Introduced new CSS styles in `site/assets/css/style.css` for
blockquotes and `.content-highlight`, including dark mode support, hover
effects, and improved readability for both standard and highlighted
callouts.
* Improved spacing and appearance for footnote references and headings
for better readability.

**Operating Models Guide Updates**

* Updated `site/content/operating-models/2026.1/index.md` to use
`[!HIGHLIGHT]` and `[!note]` callouts for emphasizing key insights and
distinctions, added supporting quotes, and clarified explanations for
simple vs. complex work and market contexts.
[[1]](diffhunk://#diff-a178d9089c31e3eade062a21da95ea3cca2d36d3f5ff3786f300a6465a0b1775L37-R40)
[[2]](diffhunk://#diff-a178d9089c31e3eade062a21da95ea3cca2d36d3f5ff3786f300a6465a0b1775R64-R65)
[[3]](diffhunk://#diff-a178d9089c31e3eade062a21da95ea3cca2d36d3f5ff3786f300a6465a0b1775R77-R97)
[[4]](diffhunk://#diff-a178d9089c31e3eade062a21da95ea3cca2d36d3f5ff3786f300a6465a0b1775L84-R110)
[[5]](diffhunk://#diff-a178d9089c31e3eade062a21da95ea3cca2d36d3f5ff3786f300a6465a0b1775R156-R158)
[[6]](diffhunk://#diff-a178d9089c31e3eade062a21da95ea3cca2d36d3f5ff3786f300a6465a0b1775R171-R185)

**Front Matter Options**

* Documented all available front matter options for content pages,
including `enableMermaid`, in `docs/content-management.md` for easier
configuration and discoverability.

<!-- Reviewable:start -->
- - -
This change is [<img src="https://reviewable.io/review_button.svg"
height="34" align="absmiddle"
alt="Reviewable"/>](https://reviewable.io/reviews/ScrumGuides/ScrumGuide-ExpansionPack/293)
<!-- Reviewable:end -->
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

None yet

Development

Successfully merging this pull request may close these issues.

2 participants