GoogleCloudPlatform / GoogleCloudPlatform/open-knowledge-format

JSON Schema for the OKF YAML MD Frontmatter

Open
#8 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
467
Forks
35
Avg merge
9m
Merged PRs (30d)
1

Description

How about writing a [JSON Schema](https://json-schema.org) for the [OKF YAML MD Frontmatter](https://github.com/GoogleCloudPlatform/open-knowledge-format/blob/main/SPEC.md)?

I would then use this e.g. to validate my https://github.com/enola-dev/wiki.

Maybe I'll write one, and contribute it here.

Unless someone gets to it before I do.

Contributor guide

Open the contributing guide

Research direction

Start by reading SPEC.md to identify every field and constraint in the OKF YAML MD frontmatter. Then locate the appropriate place in the repository for a JSON Schema and determine how it can be checked against the format; done means the schema represents the documented frontmatter and can support validation of an external OKF wiki.

Written by the indexing model from the issue text.

Assessment

Tech stack
json, markdown, yaml
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.