unicef / kindly

GNU Affero General Public License v3.0
24 stars 17 forks source link

Onboarding docs with contribution guidelines #115

Open sabinevidal opened 2 years ago

sabinevidal commented 2 years ago

Adding a contributions section to the docs website to outline how and where people can contribute.

Still to do:

sabinevidal commented 2 years ago

@nathanfletcher @jwflory: I have added more info into the overview. I want to flesh out the docs overview a little bit more as this would likely be a first stopping point for new contributors. I thought we could include the contribution guidelines (mentioned in #125) on the api maintenance page. Would appreciate your thoughts when you have a chance, on where I can add more or less detail. Thanks!

nathanfletcher commented 2 years ago

@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

sabinevidal commented 2 years ago

@nathanfletcher: Here's the PR for the contribution docs updates!

sabinevidal commented 2 years ago

@nathanfletcher @jwflory Is there anything else I need to add to the docs from updates the last month? Also need to add the link + info for the SwaggerAPI as well as the guidelines/code of conduct for contributions too.

jwflory commented 2 years ago

@nathanfletcher Is this PR ready for final review?