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.

Sign up for GitHub

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

Jump to bottom

Blueprints onboarding documentation #64

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

Blueprints onboarding documentation #64

adamziel opened this issue Mar 6, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation V1
Milestone
Blueprints commun...

Comments

@adamziel
Copy link
Collaborator

adamziel commented Mar 6, 2024 •
edited
Loading

Let's create resources for Blueprint developers to cover topics such as:

  • What are Blueprints and how are they useful?
    • They're build scripts for WordPress sites
    • The same Blueprints can spin a WordPress site in Playground, in your local dev env, and on a hosting
  • Your first Blueprint
    • Let's set up a simple WordPress site
    • JSON structure overview
    • Developer aids – JSON schema, this documentation
  • Basics – how to set up a WordPress site with Blueprints?
    • How to install a plugin or a theme....
      • From the WordPress plugin directory
      • From a URL
      • (future) From a disk
      • (future) From a Git repository
    • How to install a plugin without activating it?
    • How to install multiple plugins?
    • How to set up starter content?
      • By importing a WXR file
      • By shipping a plugin that creates the content
    • How to install an mu-plugin?
    • How to ensure the Blueprint works consistently in different runtimes?
      • Playground – enable extra PHP extensions and networking, learn about the CORS limitations
      • Native
  • Intermediate
    • How to set up a multisite?
    • How to import data from an SQL file?
    • How to customize a PHP version?
    • How to customize a WordPress version?
    • How to set up arbitrary files with a Blueprint?
    • How to run custom PHP code?
    • How to set PHP.ini flags?
    • How to install and use wp-cli?
  • Advanced examples and use-cases
    • How to set up a plugin demo on your website?
    • How to set up a restaurant site showcase?
    • How to set up an ecommerce store showcase?
    • Advanced example: how are live translations set up?
  • Getting help
    • GitHub issues
    • Community forums
    • Slack channel

The outline above is just a conversation starter. Let's identify what's missing and which documents are the most important to prioritize.

cc @bph @nickdiego @justintadlock @annezazu @dmsnell
@adamziel adamziel added documentation Improvements or additions to documentation V1 labels Mar 6, 2024
@adamziel adamziel added this to the Blueprints community space milestone Mar 6, 2024
This was referenced Mar 6, 2024
Closed
Open
Open
@adamziel
Copy link
Collaborator Author

Noting that the Blueprints v2 spec discussion is in progress, it shouldn't block these v1 docs. They will still be highly valuable and not too difficult to adjust when the v2 is ready.

@adamziel
Copy link
Collaborator Author

cc @ironnysh – you might be interested in this issue.

@adamziel adamziel mentioned this issue Mar 12, 2024
Closed
This was referenced Mar 21, 2024
Open
Open
@adamziel adamziel mentioned this issue Apr 5, 2024
Merged
adamziel added a commit to WordPress/blueprints that referenced this issue Apr 15, 2024
@adamziel @ironnysh @bph
Blueprints Crash Course (#5)
cf51f27 
Launching this Blueprint community space hinges on good materials to
explain what Blueprints are and how developers can work with them.

This PR proposes a few pages to cover:

1. What are Blueprints and how are they useful?
2. How to run Blueprints
3. Building your first Blueprint
4. Debugging Blueprints
5. Developer Tools
6. More Resources

It's a loose interpretation of [the previously proposed
outline](WordPress/blueprints-library#64) that
covers roughly the same topics in a lean way.

## Reviewing

[<kbd> <br>Preview proposed
documentation<br> </kbd>](https://github.com/adamziel/blueprints/blob/blueprints-crash-course/docs/index.md)

cc @flexseth @bph @jonathanbossenger @ironnysh @westnz @justintadlock
@annezazu @bgrgicak @brandonpayton @dmsnell for your opinions. I'd love
to learn:

1. Do you think this covers enough to launch the Community Space and
iterate later?
2. Are these pages clear? Do they do a good job of getting a person from
0 to familiar?
3. What would you change?

## Documentation format

This PR uses Markdown because it's easy to write and can be readily
previewed on GitHub.

In parallel, we're exploring [a Playground-based documentation writing
workflow](https://github.com/adamziel/playground-docs-workflow). It's
not ready for production use yet and I didn't want to block the
community space on these explorations. Once it's finished, these docs
should be easy to migrate.

Closes #2

---------

Co-authored-by: Ronny Shani <63248335+ironnysh@users.noreply.github.com>
Co-authored-by: Birgit Pauli-Haack <birgit.pauli@gmail.com>
@flexseth flexseth mentioned this issue Apr 18, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation V1
Projects
None yet
Milestone
Blueprints community space
Development

No branches or pull requests
1 participant
@adamziel