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

Design vocabulary design using Github dev tools #10

Open
4 tasks
jesserobertson opened this issue Jun 6, 2020 · 3 comments
Open
4 tasks

Design vocabulary design using Github dev tools #10

jesserobertson opened this issue Jun 6, 2020 · 3 comments
Labels
help wanted Extra attention is needed question Further information is requested vocabulary Issues related to vocab development

Comments

@jesserobertson
Copy link

I think it would be worthwhile to have a crack at a Github-centered approach to developing vocabularies with the community. We've had some pretty good discussions from tech and non-tech people using the Github discussion boards, and I think we could maintain schemas and contexts alongside this, coupled with a more in-depth use of GitHub's code review tools.

I'd suggest the following groundwork needs to be laid:

  • A good contributing.md doc that lays out how you could use pull requests and code reviews to make changes to central contexts and schemas
  • A better explanation of what goes where in the repo
  • A way of linking issues to new branches (have installed
  • [maybe] agreeing on a workflow for linking issues to our project boards so that you can see what bits of the vocab are being worked on

Then we'd have to do the hard work of getting people to actually engage but at least there might be clear guidelines.

@jklump @dr-shorthair @fils @ramdeensarah thoughts?

@jesserobertson jesserobertson added help wanted Extra attention is needed question Further information is requested vocabulary Issues related to vocab development labels Jun 6, 2020
@jklump
Copy link
Member

jklump commented Jun 9, 2020

The benefit of doing the vocabulary development in GitHub would be that everything is on one platform. Is there any example we can learn from and refer to?

The alternative would be to use ARDC's PoolParty, which is a dedicated vocabulary development tool, but it sits on a different system.

@jesserobertson
Copy link
Author

@jklump not sure that there is an existing example. The other benefit to using GitHub is that we can maintain the continuous integration aspects, which helps because we're not just creating a vocabulary but also a coupled JSONSchema as part of the profile.

Also I don't know whether PoolParty supports JSON?

@jesserobertson
Copy link
Author

Happy to use poolparty for the vocab development if this is easier for everyone though - I guess there just needs to be a path to a working profile somewhere.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed question Further information is requested vocabulary Issues related to vocab development
Projects
None yet
Development

No branches or pull requests

2 participants