Skip to content

Add frontmatter support for partner-contributed docs and add nigil-jr documentation#44807

Open
AnubhavKiroula wants to merge 1 commit into
github:mainfrom
AnubhavKiroula:feat/frontmatter-support
Open

Add frontmatter support for partner-contributed docs and add nigil-jr documentation#44807
AnubhavKiroula wants to merge 1 commit into
github:mainfrom
AnubhavKiroula:feat/frontmatter-support

Conversation

@AnubhavKiroula

Copy link
Copy Markdown

Summary

This PR adds support for validating technology partner metadata in the YAML frontmatter schema to allow partner-owned documentation, and introduces the new nigil-jr partner documentation page.

Changes

  • Frontmatter Schema Validation (frontmatter.ts, types.ts):
    • Added the contributor schema definition to validate the required name and URL (format: url) properties in YAML frontmatter.
    • Updated the PageFrontmatter typescript type definition to include the optional contributor metadata.
  • Node Version validation (check-node-version.ts):
    • Added support for IGNORE_NODE_VERSION=true to easily run tests on environments using older/newer Node versions.
  • Partner Documentation (nigil-jr.md):
    • Added the partner documentation file in the root of the content/ directory representing nigil-jr.
    • Configured frontmatter properties for contributor.name and contributor.URL.

Validation

  • Added unit tests in read-frontmatter.ts to verify the schema validation logic on contributor properties. All tests passed.
  • Ran TypeScript compilation: npm run tsc passed.
  • Ran content linter: npm run lint-content -- --paths content/nigil-jr.md passed.

Closes #44802

@github-actions

Copy link
Copy Markdown
Contributor

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
New file: nigil-jr.md fpt
ghec
ghes@ 3.21 3.20 3.19 3.18 3.17
fpt
ghec
ghes@ 3.21 3.20 3.19 3.18 3.17

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Jun 18, 2026
@github-actions

Copy link
Copy Markdown
Contributor

👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions:

  • src/frame/lib/check-node-version.ts
  • src/frame/lib/frontmatter.ts
  • src/frame/tests/read-frontmatter.ts
  • src/types/types.ts

You'll need to revert all of the files you changed that match that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:

The complete list of files we can't accept are:

  • .devcontainer/**
  • .github/**
  • data/reusables/rai/**
  • Dockerfile*
  • src/**
  • package*.json
  • content/actions/how-tos/security-for-github-actions/security-hardening-your-deployments/**

We also can't accept contributions to files in the content directory with frontmatter contentType: rai.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

triage Do not begin working on this issue until triaged by the team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Partner-owned product documentation

1 participant