json-schema-org / json-schema-org/website
Create a JSON Schema Glossary Page or Site
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 169
- Forks
- 484
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 6
Description
It'd be nice if we had a glossary of terms -- a page, in not very technical jargon, which explains common terminology used by us in conversation, and which could be linked to by other pages or people in order to answer questions like "what is a vocabulary" in a succinct way.
Here are two examples of glossaries I've contributed to or used heavily which may be decent examples of the concept:
EDIT: The page has been published at https://json-schema.org/learn/glossary.html
To help, just grab any of the entries below which don't already exist on the page, and share that you're working on them!
List of Terms to Define
- dialect json-schema-org/json-schema-org.github.io#484
- instance json-schema-org/json-schema-org.github.io#462
- vocabulary json-schema-org/json-schema-org.github.io#484
- schema json-schema-org/json-schema-org.github.io#462
- meta-schema json-schema-org/json-schema-org.github.io#469
- keyword json-schema-org/json-schema-org.github.io#469
- hyper-schema #156
- draft json-schema-org/json-schema-org.github.io#461
- subschema json-schema-org/json-schema-org.github.io#520
- JSON json-schema-org/json-schema-org.github.io#521
- annotation (In progress)
- validation (In progress)
- anchor (In progress)
- annotation (keyword)
- applicator (keyword)
- in-place applicator
- child applicator
- assertion (keyword)
- JSON pointer (In progress)
- validation result (In progress)
- ref (In progress)
- resource / schema resource (In progress)
- compound schema resource (In progress)
- relative JSON pointer
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.
Research direction
The issue points to the published glossary at https://json-schema.org/learn/glossary.html and lists terms that were completed or marked in progress. Start by reviewing that page against the remaining unchecked terms in the issue; the work is done when the glossary entries are complete and suitable for linking from other pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100