-
Notifications
You must be signed in to change notification settings - Fork 9.1k
Closed
Labels
Description
The draft registry is built with Jekyll collections. Each item in the collection, representing a registry entry, is a markdown file containing machine-readable properties in YAML front matter, followed by the content of the registry entry page. Here's an example of an Alternative Schema registry entry:
---
owner: darrelmiller
issue: 1532
description: JSON Schema
layout: default
---
# <a href="..">{{ page.collection }}</a>
## {{ page.slug }} - {{ page.description }}
The `{{ page.slug }}` `alternativeSchema` `type` refers to [JSON Schema](http://json-schema.org/) in any version.
{% if page.issue %}
### GitHub Issue
* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }})
{% endif %}
We agreed on a recent TSC call that we'd like to better encapsulate the layout for registry entry pages. There are several benefits:
- It's less boilerplate code that contributors have to copy-and-paste into a new registry entry.
- It's easier for TSC reviewers to verify that the submission is correct and conformant.
- This ensures that we see a uniform layout on all registry entry pages.
- It's easy for us to update the layout of all entries in a given registry (i.e. a given Jekyll collection) without having to edit individual registry entries.
This seems to be easy to solve with Jekyll {% include %}
tags, described here.
Metadata
Metadata
Assignees
Labels
Type
Projects
Status
Done