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

Add developer docs (second tutorial?) explaining how to use the taxonomy, annotate a dataset, etc. #110

Closed
NevilleS opened this issue Sep 22, 2021 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@NevilleS
Copy link
Contributor

Right now there's a big chunk of developer documentation missing, which should cover:

  • why the dataset resource exists
  • how to create a dataset to represent your database schema
  • why the data categories taxonomy exists
  • how the data categories taxonomy is structured
  • how to annotate your dataset with data categories
  • etc.
@NevilleS NevilleS added the documentation Improvements or additions to documentation label Sep 22, 2021
@ThomasLaPiana
Copy link
Contributor

it sounds like generally we just need a better resources page, all of this stuff should be clear after reading that page

@brentonmallen1 made the great observation that just reading the resources page doesn't tell you much about why any of that stuff matters or how to use it, just how to define it

@NevilleS
Copy link
Contributor Author

I discussed a plan for documentation updates with @cilliankieran and @iamkelllly this morning; we've got several docs planned that should cover this and more. Assigning this issue to @iamkelllly as she's working with a writer on a more detailed walkthrough/tutorial.

@NevilleS
Copy link
Contributor Author

@iamkelllly was #145 intended to close this one?

@iamkelllly
Copy link
Contributor

Yes, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants