[💻 Hack Pod] Hack on Documentation with Blacktocats 12/15?

[manishapriya94]

When

Wednesday, February 15th, 11:30 -1 pm pt https://github.zoom.us/j/97013759503?pwd=aDd5NmNKQTNsbGlLQWhuSm4vVEFGdz09 Event Details: 40-80$ of Benevity donations

What are we hacking on?

Goal: Improve Amplify's documentation and use it to provide a good model of documentation and OSS maintainership for MLH fellows

Background

As part of our ongoing Open Source Mentorship program, fellows have been working on Amplify. We'd like to clean up and organize the documentation, add some things to improve the contributor workflow, and start working on documenting the app's API endpoints and third party API usage using OpenAPI

Project Board

Project Documentation

• [ ] https://github.com/ProgramEquity/amplify/issues/357
• [ ] https://github.com/ProgramEquity/amplify/issues/356

API Documentation with OpenAPI

Issues

• [ ] https://github.com/ProgramEquity/amplify/issues/125
• [ ] https://github.com/ProgramEquity/amplify/issues/411
• [ ] https://github.com/ProgramEquity/amplify/issues/492

Draft PRs

• [ ] https://github.com/ProgramEquity/amplify/pull/272
• [ ] https://github.com/ProgramEquity/amplify/pull/412

Contributor Workflow Improvements

• [ ] https://github.com/ProgramEquity/amplify/issues/355
• [ ] https://github.com/ProgramEquity/amplify/issues/410
• [ ] https://github.com/ProgramEquity/amplify/issues/413

Resources:

• Workshop Recording on Documentation
• OSS Documentation Example Repo

[blackgirlbytes]

I volunteer

[blackgirlbytes]

@ghostinhershell is also interested!

[manishapriya94]

@ipc103 do you think folks from ospo would join this event in celebration with Octo7 and Blacktocats?

[ipc103]

Good idea - I shared this with our team ❤️ I have a conflict but will try to join for at least part of the time.