Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Onboarding to contributing documentation #1159

Open
adamziel opened this issue Mar 29, 2024 · 2 comments
Open

Onboarding to contributing documentation #1159

adamziel opened this issue Mar 29, 2024 · 2 comments
Labels
[Type] Documentation Improvements or additions to documentation [Type] Enhancement New feature or request

Comments

@adamziel
Copy link
Collaborator

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 #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 adamziel added [Type] Documentation Improvements or additions to documentation [Type] Enhancement New feature or request labels Mar 29, 2024
@flexseth
Copy link
Collaborator

flexseth commented Mar 30, 2024

@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

@adamziel
Copy link
Collaborator Author

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/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Documentation Improvements or additions to documentation [Type] Enhancement New feature or request
2 participants