Execute the documentation strategy

[Relequestual]

Purpose

The purpose of this issue is to execute the Documentation strategy defined in issue #245 .

Scope

See issue #245 .

Objectives

See issue #245 .

Repository

All the changes will be implemented in the new website repo: https://github.com/json-schema-org/website

Plan

🏁 Release 1

• overview\What is JSON schema PR 47
• learn\Getting started PR 46

🏁 Release 2

• Examples: Improve structure and consistency.
  • Miscellaneous Examples page. [Docs] Updated 'Miscellaneous Examples' Section #48
  • Other Examples page. [Docs] Updated Examples Section #62
• Website Analytics  community#300
• learn\Glossary (https://json-schema.org/learn/glossary.html)
• Links to similar technologies #126
• add links to openapi website #127

🏁 Release 3

• [📑 Docs]: Lets create a welcome page for the docs section #421
• cookbook page, with solutions to frequently asked questions #190
• Create a new page for Community inside the Overview Section of the Docs. #280
• ✨ Enhancement: Page in overview section to show Case Studies #440
• ✨ Enhancement: Create the use cases page #426

🏁 Release TBD

• Add a new section in the Docs for other JSON Schema resources #282
• Add a newsletter subscribe form to the Landing Page #243
• ✨ Enhancement: Newsletter landing page #634

🏁 Release 4

• [📝 Docs]: Implement the Spec page restructuring (Docs Website) #791

🏁 Release 5
Rebuild the Reference docs

• Replace Understanding JSON Schema
• Review UJS conventions / language-specific notes #110

🏁 Release 6

• Create a guide for implementers #180
• Undocumented features/keywords on the website is reduced to zero. #960
• [📝 Docs]: Create guide "How to validate data against a JSON schema"  #954
• [📝 Docs]: Create guide "How to structure a complex JSON schema" #950
• Creating a dedicated JSON Hyperschema page. #971
• Creating a Migration docs for all drafts. #970

🏁 Release 7

• Roadmap page for the Overview section #181
• Implement breadcrumbs. #801
• overview\Vision (New)
• overview\Release and Versioning (New)

🏁 Release 8

• Guide for Bowtie
• Guide for Test Suite

🏁 Release 9

• Guide of use of JSON Schema at scale.

🏁 Release 10

• Metaschemas documentation
• Explain meta-schema status and support #141

Success Metrics

See issue #245 .

Risks

See issue #245 .

Governance

We'll use milestones to group releases.

This is the group of people working in this project:

• @benjagm
• @mjgutermuth
• @aku1310

[benjagm]

I made some changes in the order of Releases 7 and subsequent compared with the order available in https://github.com/orgs/json-schema-org/discussions/386.
Instead of:
🏁 Release 7
Integrate Learnjsonschema
🏁 Release 8
Tutorial for Bowtie
Tutorial for Test Suite
🏁 Release 9
Replace Understanding JSON Schema
🏁 Release 10
Tutorial creating and maintaining a JSON Schema Implementation

We have:
🏁 Release 7
Tutorial for Bowtie
Tutorial for Test Suite
🏁 Release 8
Tutorial creating and maintaining a JSON Schema Implementation
🏁 Release 9
Integrate Learnjsonschema
🏁 Release 10
Replace Understanding JSON Schema

The reason is to better adjust to the recent discussions to enable implementers with more resources.

[benjagm]

Release 1 completed. Excellent work @mjgutermuth and @aku1310.

[github-actions]

Hello! 👋

This issue has been automatically marked as stale due to inactivity 😴

It will be closed in 180 days if no further activity occurs. To keep it active, please add a comment with more details.

There can be many reasons why a specific issue has no activity. The most probable cause is a lack of time, not a lack of interest.

Let us figure out together how to push this issue forward. Connect with us through our slack channel : https://json-schema.org/slack

Thank you for your patience ❤️