source-cooperative / source-cooperative/docs.source.coop
Best practice for data product
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1
- Forks
- 2
- Avg merge
- 25m
- Merged PRs (30d)
- 2
Description
(Part 1) Confirm what should all be included in the data product metadata
(Part 2) Implement into the docs.
Current items we see as valuable / suggested / required:
- Description of the data product
- License information (separate for metadata vs data)
- Access examples (interactive maps preferred over downloads)
- Contact information
- Citation/DOI information
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 with the proposed metadata list in the issue and review the repository's existing documentation structure to find where data-product guidance belongs. Confirm the complete metadata requirements before documenting them; done means the agreed checklist and implementation are clearly included in the docs.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100