website icon indicating copy to clipboard operation
website copied to clipboard

Execute the documentation strategy

Open Relequestual opened this issue 2 years ago • 4 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
  • [x] #634

🏁 Release 4

  • [x] #791

🏁 Release 5 Rebuild the Reference docs

  • [x] Replace Understanding JSON Schema
  • [x] https://github.com/json-schema-org/website/issues/110

🏁 Release 6

  • [ ] #180
  • [x] #960
  • [ ] #954
  • [ ] #950
  • [ ] #971
  • [ ] #970

🏁 Release 7

  • [x] #181
  • [x] #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
  • [ ] 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

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 avatar Jun 22 '23 15:06 benjagm

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

benjagm avatar Jul 20 '23 07:07 benjagm

Hello! :wave:

This issue has been automatically marked as stale due to inactivity :sleeping:

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 :heart:

github-actions[bot] avatar Aug 18 '24 01:08 github-actions[bot]