Skip to content

Wiki planning

Beka Westberg edited this page May 1, 2020 · 60 revisions

This page is meant to help plan how the wiki will be set up and organized. It is not meant to stick around forever, but be around temporarily until a minimum viable wiki is completed.

Process for writing pages

Draft->needs review->draft->needs review->published

For draft pages, put an "under construction" section in at the top (:warning: :construction: This page is under construction! :construction: :warning:) and use a horizontal rule to separate it from the rest of the page. You can also add comments there on what needs work.

For needs review pages, put a "needs review" section in at the top (:interrobang: Needs review :interrobang:)and use a horizontal rule to separate it from the rest of the page. You can also add comments there on what needs review.

For broader discussion, add a horizontal rule and a "Talk" header under the main content of the page.

We will likely need more process but this is a start.

Page Status

Published

(These pages may still be edited, but are ready for general consumption.)

In review/ready for review

In progress

Ready to be written/Needs work

  • Compatibility for plugins
    • Should work on all major browsers
    • Use browserslist section in package.json
  • Guidelines on using Blockly APIs
    • Don't use private or package functions
    • If you need a private API, discuss it with the Blockly team + list private APIs used in your README

Needs decisions from Blockly team

  • What is a codelab?
  • Codelab style guide
  • What is an example?
  • Example style guide
  • First-party vs third-party plugins
    • Discussed in "adding a plugin"
  • How to write and run tests for plugins
  • Style guide for plugins

Research

Contributing

Talk

🐙 is Rachel

❕ and ❔ are Beka

🦘 is Sam