website icon indicating copy to clipboard operation
website copied to clipboard

Execute the documentation strategy

Open Relequestual opened this issue 1 year ago • 2 comments

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

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

🏁 Release 2

  • [x] Examples: Improve structure and consistency.
    • [x] Miscellaneous Examples page. #48
    • [x] Other Examples page. #62
  • [x] json-schema-org/community#300
  • [x] learn\Glossary (https://json-schema.org/learn/glossary.html)
  • [x] #126
  • [x] #127

🏁 Release 3

  • [x] #421
  • [x] #190
  • [x] #280
  • [x] #440
  • [x] #426

🏁 Release TBD

  • [x] #282
  • [x] #243
  • [ ] #634

🏁 Release 4

  • [ ] Implement breadcrumbs. Rebuild the Specification docs
  • [ ] Improve format and structure.
  • [ ] Create a changelog to better manage the release notes.

🏁 Release 5 Rebuild the Reference docs

  • [ ] Replace Understanding JSON Schema
  • [ ] https://github.com/json-schema-org/website/issues/110
  • [ ] Undocumented features/keywords on the website is reduced to zero.

🏁 Release 6

  • [ ] #181
  • [ ] Replace glossary by a new concepts section
  • [ ] overview\Vision (New)
  • [ ] overview\Release and Versioning (New)

🏁 Release 7

  • [ ] #180
  • [ ] Guide for Bowtie
  • [ ] Guide for Test Suite

🏁 Release 8

  • [ ] Guide of use of JSON Schema at scale.

🏁 Release 9

  • [ ] Metaschemas documentation
  • [ ] https://github.com/json-schema-org/website/issues/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

Relequestual avatar Jun 20 '23 10:06 Relequestual