search

openedx / wg-devops

Issue repository for the DevOps Working Group
1 stars 2 forks source link

Improve explanation of patches in V1 Plugin API docs #29

Open kdmccormick opened 2 years ago

kdmccormick commented 2 years ago

Background

Based on this Slack conversation: https://openedx.slack.com/archives/C02V3GHE3UP/p1655384231694799

Essentially, the v0 API docs put the concept of "patches" front-and-center, and had a nice little explanation of them. The equivalent V1 docs for patches are nested under Reference -> Hooks API -> Constants, and they are very basic. There is a Template Patches reference page, but it does not explain patches, it just lists them.

Tasks

Make it so it's easier for new plugin developers to understand what a patch is. This could involve adding a new docs section, improving the existing ones, or both.

MaferMazu commented 1 year ago

I can work on this @kdmccormick

MaferMazu commented 1 year ago

I started this work here: https://github.com/overhangio/tutor/pull/852