json-schema-org / json-schema-org/website
Execute the documentation strategy
Open
@benjagm is already working on this.
Since Jun 20, 2023.
📝 Documentation
Priority: Medium
Status: In Progress
- Dominant language
- HTML
- Stars
- 169
- Forks
- 484
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 6
Description
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
- Examples: Improve structure and consistency.
- Miscellaneous Examples page. #48
- Other Examples page. #62
- json-schema-org/community#300
- learn\Glossary (https://json-schema.org/learn/glossary.html)
- #126
- #127
🏁 Release 3
- #421
- #190
- #280
- #440
- #426
🏁 Release TBD
- #282
- #243
- #634
🏁 Release 4
- #791
🏁 Release 5
Rebuild the Reference docs
- Replace Understanding JSON Schema
- https://github.com/json-schema-org/website/issues/110
🏁 Release 6
- #180
- #960
- #954
- #950
- #971
- #970
🏁 Release 7
- #181
- #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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.