OpenRefine / OpenRefine/openrefine.org
Document Wikibase schema format
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 161
- Forks
- 142
- Avg merge
- 6h 10m
- Merged PRs (30d)
- 9
Description
OpenRefine lets users import and export the Wikibase schemas that they use in the tool, in the JSON format we use internally.
It could be useful to document this format which could be adopted by other tabular data integration tools.
Proposed solution
- Document the overall structure of the schema in the developer docs
- Offer a JSON schema
Alternatives considered
Perhaps there are reasons why we should instead want to keep this private? What sort of stability / versioning policy do we want to have here?
Additional context
Brought up in a discussion with @addshore
Contributor guide
No contributing guide indexed for this repository
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
Start by reviewing the existing developer docs and the internal Wikibase schema JSON format used for import and export. Document the overall schema structure and provide a JSON schema. Before considering the work done, resolve whether the format should be public and what stability or versioning policy it needs.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100