Onboarding docs with contribution guidelines #115
Conversation
|
@nathanfletcher @jwflory: I have added more info into the overview. |
|
@sabinevidal it seems the docs check failed because of a url https://github.com/unicef/kindly/runs/5067906279?check_suite_focus=true#step:4:36 I think it looks okay but I'd like to hear what Justin also thinks of the changes |
| We are collecting training data from children on the [Kindly website](https://kindly.unicef.io/contribute). These contributions will be added to the [training dataset](ml-model/training-data) which are classified as either `offensive` or `non-offensive` to improve the model's accuracy. See the [training data docs](../ml-model/training-data) for a more technical overview. | ||
|
|
||
| ## [API Maintenance](api-maintenance) | ||
| Kindly is built as an open-source solution, and is a certified [DPG](https://digitalpublicgoods.net/registry/kindly.html). We are on [GitHub](https://github.com/unicef/kindly) and will welcome your help whatever your skills. |
There was a problem hiding this comment.
What do you think about creating a new label for API-related issues, e.g. type: API or something similar? This way, it will be easier to discover API-related tasks that someone could work on.
There was a problem hiding this comment.
I like this idea!
I think I might also rename the 'API maintenance' section to something more like 'project maintenance', as it'll not just be for the API, and there are other aspects where people cam contribute (including the current front-facing website)
There was a problem hiding this comment.
I agree, it opens up more room for participation. 👍🏻
| Kindly is built as an open-source solution, and is a certified [DPG](https://digitalpublicgoods.net/registry/kindly.html). We are on [GitHub](https://github.com/unicef/kindly) and will welcome your help whatever your skills. | ||
|
|
||
| ## [API Integration](api-integration) | ||
| Integrate the Kindly API with your own program. |
There was a problem hiding this comment.
Does the API have any documentation already? If so, could we link to it from here?
There was a problem hiding this comment.
There's a page in the docs for the API, it includes the endpoints https://unicef.github.io/kindly/api. But might be worth elaborating a little bit more for those who are new to APIs ie, that they'd have to integrate it into an existing text input.
There was a problem hiding this comment.
@sabinevidal It is a nice idea but could also be a long-term goal of providing more examples or guidance of integrating Kindly into an existing app. I think cross-linking to the existing API documentation will be enough for any developer who is taking a peek at Kindly and looking to understand what they can do with it.
There was a problem hiding this comment.
@jwflory: @nathanfletcher is building out a better API overview with SwaggerAPI, so will cross-link that here once it's complete.
Will note the API crash-course idea for a future goal - I know @amreenp7 was in the process of talking to people about creating course material for children incorporating Kindly - so could be included in that discussion.
| Check out the [development docs](../technical/development) to see how to set up a development environment so you can work on the Kindly repo. | ||
| Our backend is set up as an API, so you can also make calls to this on Postman or with `curl`. We also have a [website](https://kindly.unicef.io) where you can check phrases with Kindly, alternatively once you've set up the development environment you can use the [web client](../overview#web-client) to test phrases. | ||
|
|
||
| ## Contribution Guidelines |
There was a problem hiding this comment.
@nathanfletcher We can maybe add the guidelines at this point? Or even a link if we're doing them somewhere else.
|
@nathanfletcher: |
|
@nathanfletcher @jwflory |
|
@nathanfletcher Is this PR ready for final review? |
Adding a contributions section to the docs website to outline how and where people can contribute.
Still to do: