Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Execute the documentation strategy #158

Open
16 of 33 tasks
Relequestual opened this issue Jun 20, 2023 · 2 comments
Open
16 of 33 tasks

Execute the documentation strategy #158

Relequestual opened this issue Jun 20, 2023 · 2 comments
Assignees
Labels
📝 Documentation Indicates improvements or additions to documentation. Priority: Medium This issue may be useful, and needs some attention. Status: In Progress This issue is being worked on, and has someone assigned.

Comments

@Relequestual
Copy link
Member

Relequestual commented Jun 20, 2023

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

🏁 Release 3

🏁 Release TBD


🏁 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

🏁 Release 6

🏁 Release 7

🏁 Release 8

  • Guide of use of JSON Schema at scale.

🏁 Release 9

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 benjagm changed the title Define a documentation strategy Documentation strategy Jun 21, 2023
@benjagm
Copy link
Collaborator

benjagm commented Jun 22, 2023

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 benjagm added the 📝 Documentation Indicates improvements or additions to documentation. label Jun 29, 2023
@benjagm
Copy link
Collaborator

benjagm commented Jul 20, 2023

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

@benjagm benjagm transferred this issue from json-schema-org/community Oct 16, 2023
@benjagm benjagm pinned this issue Oct 16, 2023
@benjagm benjagm modified the milestone: Release 2 Nov 24, 2023
@benjagm benjagm changed the title Documentation strategy Execute the documentation strategy Nov 24, 2023
@benjagm benjagm added Priority: Medium This issue may be useful, and needs some attention. Status: In Progress This issue is being worked on, and has someone assigned. labels Feb 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Documentation Indicates improvements or additions to documentation. Priority: Medium This issue may be useful, and needs some attention. Status: In Progress This issue is being worked on, and has someone assigned.
Projects
Status: In Progress
Development

No branches or pull requests

2 participants