Skip to content

Latest commit

 

History

History
55 lines (41 loc) · 3.87 KB

blog-guidelines.md

File metadata and controls

55 lines (41 loc) · 3.87 KB
Raw

JSON Schema Blog Guidelines

JSON Schema Blog Overview

The JSON Schema blog serves as a channel for project maintainers and contributors, implementation maintainers, and JSON Schema Champions to share content with the JSON Schema Community.

The content on our blog consists of:

  • Use cases and success stories
  • Technical content and how-to’s
  • Stories, updates and opinions about JSON Schema
  • Articles to present JSON Schema tooling
  • Industry insight into JSON Schema adoption
  • JSON Schema Community updates and reports

Other topics are welcome, but it needs to have a direct link to the JSON Schema Community.

We accept content from JSON Schema maintainers and contributors, implementation maintainers, and JSON Schema Champions.

Blog type definitions:

  • Tooling blog: Any blog post on a JSON Schema implementation.
  • Community blog: Any blog post about the Community written by a JSON Schema maintainer or contributor.
  • Ambassador blog: This is a blog written by one of the JSON Schema Ambassadors.
  • Opinion: This is a blog written by one of the JSON Schema maintainers or contributors to share a JSON Schema related opinion.
  • Update: This is a blog written by one of the JSON Schema maintainers to update about the project evolution.
  • Engineering: Any JSON Schema related technical post.

Content

The JSON Schema blog audience is developers, IT operators, and JSON Schema enthusiasts. Keep this in mind as you develop your blog content.

Some things to think about:

  • Posts from members must be vendor-neutral. The post may mention a vendor’s name as it relates to specific open source projects, project deployments, adoption paths, their hosting of an in-person event or speaking at an event, or other indications of meaningful participation in the Community, but it shouldn’t feel like an advertisement for your services or company. We do not accept announcements or press releases to the JSON Schema blog.
  • The most interesting posts are how-to blogs, blogs with technical content, and those that teach or show how to do something in a way others may not have thought of.
  • Blog posts that show hurdles that were encountered and explain how they were overcome often do very well as the Community is looking to learn.
  • Critical commentary or broad issues must be approached with sensitivity, professionalism, and tact in a way that is beneficial and positive for the Community.
  • Your post must be your content, but can be published elsewhere with a right to republish. All content should have an author and be published Creative Commons with Attribution.

Members can add 1-2 sentences at the end of their blog with a link to an external site such as their website or a gated asset. Examples for best practices:

  • Share contact info of speaker - twitter, slack, email
  • Links to company websites
  • Links to projects websites or Github
  • Can advertise if they are hiring and who to contact if interested

The JSON Schema project will review the statement, as we do for the content for the blog, to approve the content. If changes are needed, we will provide feedback or suggested changes.

Promotion

Please feel free to share the blog on social media.

How to submit an article for consideration

Please create an issue to introduce your blog idea as first step. If the article is not suitable for the JSON Schema blog, we will provide feedback and direction. Once the issue has been accepted you can proceed with the PR. Find here an example of blog PR.

Note on JSON Champions

Until we publish an official definition of JSON Schema Champion, we consider JSON Schema Champions to experts, educators, authors, and event organizers relevant to the JSON Schema ecosystem.

Atribution

These blog guidelines are adapted by the CNCF blog guidelines.