Skip to content

Add a release post JSON schema

James Ramsay (ex-GitLab) requested to merge release-post-json-schema into master

Why is this change being made?

JSON schema is the most popular schema format for JSON and YAML files. Adding the schema file allows it to be used in VSCode and perhaps in the future by the GitLab Web IDE.

This change does not replace the existing linting and validation of release post items, but can be considered preparation for some refactoring.

To use this locally in VS Code while working on release post items:

  1. Install https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml
  2. Update your VSCode workspace config (see https://code.visualstudio.com/docs/getstarted/settings)
{
    "yaml.schemas": {
        "data/schemas/releasepost.schema.json": ["data/release_posts/*/*.yml", "data/release_posts/*/*.yaml"],
    }
}
Hover documentation Auto-complete
2020-07-06T15.11.05 2020-07-06T15.12.06

Author Checklist

  • Correct MR template applied (e.g blog post)
  • Provided a concise title for the MR
  • Added a description to this MR explaining the reasons for the proposed change, per say-why-not-just-what
  • Assign this change to the correct DRI
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to your manager.
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies.
    • If the changes relate to any part of the project other than updates to content and/or data files please make sure to ping @gl-static-site-editor in a comment for a review and merge. For example changes to .gitlab-ci.yml, JavaScript/CSS/Ruby code or the layout files.

For help with failing pipelines reach out in #mr-buddies in Slack

Edited by James Ramsay (ex-GitLab)

Merge request reports

Loading