pxt-microbit
pxt-microbit copied to clipboard
Feature: Tutorial approval process
The docs at https://makecode.com/writing-docs/user-tutorials describe a tutorial approval process that is not fully documented. This ticket is to setup a lightweight process so that the Foundation and MakeCode can have some QA over submissions without discouraging or preventing anyone creating a tutorial.
Currently, people can create Tutorials on their own or add them as part of documenting an extension. The process is the same as extensions, you have to create a release to include a tutorial
Suggested workflow
- Submit it to Foundation as part of an extension. We won’t expect or need to approve all individual tutorials eg those by a teacher.
- PR raised and Foundation and MakeCode team review as with Extensions.
- Tutorial is added it to a third party tutorial gallery page
Assumptions
- License: MIT as with extension, no additional licenses required
- Unapproved content
removed from the title bar when the tutorial is approved.
- Identification get email address/github/twitter ID/phone number/linked in? public profile.
- Must join a tutorial-authors Slack Channel
- If repo gets reported to MS Github, Foundation also need a notification
TODO
- [x] Create third party tutorial page
- [ ] Update docs https://makecode.com/writing-docs/user-tutorials
- [x] Update KB https://support.microbit.org/support/solutions/articles/19000054952-makecode-extension-approval
@abchatra please edit the above if I've missed anything from our conversations
Tutorial authoring approval process for microbit:
-
Unapproved content will have warning in the title bar (as in arcade) and approved content will have report abuse in the settings (not visible without a click)
-
We will have a third party approved tutorial gallery similar to the extension gallery in the documentation (Extensions (microbit.org)).
-
License - MIT
-
Localization Support - Approval now for any language. Example: French only content
-
Image is allowed for unapproved content, however, should be hosted in github.
-
Reviewer will proofread all the text of the tutorial (will not check for quality, only for malice)
-
Tutorial author need to provide one of the following. This is to verify legitimacy.
- Email address & Phone number
- Linkedin account
-
Tutorial repo will be added at the same place as extension in the json.
@abchatra Can we schedule the work to make this live? I guess from your side the tragetconfig.json needs updating and we will need a new gallery page.
I will then create documentation for the process
Sure lets do it.
We have documented the process in https://support.microbit.org/support/solutions/articles/19000054952-makecode-extension-and-tutorial-approval#tutorials
We should update the docs here:
Though they are generic for MakeCode, the docs mention an approval process. Can we link out to the one for micro:bit or have a link in the micro:bit specific docs
https://makecode.com/writing-docs/user-tutorials#report-abuse-and-approvals
@microbit-mark can we walk through the process in the next sync. I have few comments I would like to discuss.
Rest are implemented. @ganicke can you link to microbit approval from our documentation?
@abchatra What changes need to be made to what files to add a tutorial as approved? Is it documented? Is it only https://makecode.microbit.org/tutorials? I have an example of 20+tutorials in a GitHub repo structured like an extension, but it's not an extension.
Can we discuss in our next sync? I assumed this was already documented here. https://support.microbit.org/support/solutions/articles/19000054952-makecode-extension-and-tutorial-approval#tutorials
@abchatra Yes please!