wordpress-playground icon indicating copy to clipboard operation
wordpress-playground copied to clipboard

Onboarding to contributing documentation

Open adamziel opened this issue 10 months ago • 1 comments

Let's make sure new contributors have a clear way of contributing documentation. This will come handy on the Yoast Contributor day, WCEU contributor day, and go a long way towards solid docs in general.

Related to https://github.com/WordPress/wordpress-playground/issues/772.

Questions to answer

Here's a very rough list – @zzap @flexseth let's refine it together

  • What's Playground? High-level what can I do with?
    • Develop WordPress
    • Showcase your work
    • QA workflows, PR previews
    • Blueprints
  • Important concepts
    • Playground API
    • Blueprints
    • In-browser vs local
  • How can I...
    • Write a Blueprint?
    • Run that Blueprint in the browser, wp-now, VS Code extension?
    • Build a WordPress plugin using Playground?
    • Build a simple app that integrates Playground?
    • Contribute to documentation?
  • Known limitations/roadblocks
    • Network access, CORS

cc @flexseth @zzap

adamziel avatar Mar 29 '24 16:03 adamziel

@adamziel as we discussed in the call, the best place to start contributor onboarding is for developers.

Developers provide value to end and new-users in the following ways

  • Provide blueprint examples for getting started
  • Stress test the project, find limitations and bugs, request features
  • Extend the Playground to show what you can do

The first steps to making these docs better will be geared towards developer experience. Which can be filtered in the Issues tab for this repo! (link to issues labeled developer experience)

Also... developer tools

flexseth avatar Mar 30 '24 22:03 flexseth

This might be a chore, rather than a one-off ticket, to ensure up-to-date contribution guidelines and a few high-quality task descriptions exist before each relevant contributor day.

Here's the wiki page for the Yoast Contributor day tomorrow: https://github.com/WordPress/wordpress-playground/wiki/Contributing-Documentation-at-Contributor-Day/

adamziel avatar Apr 17 '24 11:04 adamziel