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

Blueprints 101 guide #5

Merged
merged 9 commits into from
Apr 15, 2024
Merged

Blueprints 101 guide #5

merged 9 commits into from
Apr 15, 2024

Conversation

adamziel
Copy link
Contributor

@adamziel adamziel commented Apr 5, 2024

Description


Click here to read the content :-)

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 that covers roughly the same topics in a lean way.

Reviewing


Preview proposed documentation

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. 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

@adamziel adamziel added documentation Improvements or additions to documentation v1 labels Apr 5, 2024
@colorful-tones
Copy link
Member

I love the buttons to preview the changes. That helps so much. 👏

I’m curious to hear more about the “Community Space”. Is there discussion already around where and what this might look like? 🤔

Would it be a WP.org forum? A developer.wordpress.org area? Or something else?

@ironnysh
Copy link
Collaborator

ironnysh commented Apr 6, 2024

Hey @adamziel, thanks for the ping!

Gonna take a deeper look later today—I got a few suggestions :-)

@ironnysh ironnysh mentioned this pull request Apr 6, 2024
ironnysh and others added 4 commits April 8, 2024 15:12
Hi @adamziel, I made a few adjustments to the copy and file structure of
the course (renamed to _Blueprints 101_).

I hope it's okay.

PS-- I don't have access to your repo, so I made a fork and a PR of your
PR #5 :-)
minor changes, It might just be a change of simple to basic...

Shouldn't we use one of the themes from the Community Theme project as
examples, instead of an A8C theme?
I found: 

- https://wordpress.org/themes/blue-note/
- https://wordpress.org/themes/stacks/
- https://wordpress.org/themes/tt1-blocks/
Replace the 'easiest' way, as easy is in the eye of the learner, and it
is only easy for someone who already knows.
I add the word Playground a few times so that is clear that blueprints
are the configuration files for Playground. I switch the order around
and made some minor tweaks to the text.
@adamziel
Copy link
Contributor Author

A lot of good feedback and suggestions were incorporated in this PR, I'll go ahead and merge. Thank you SO MUCH @ironnysh @bph ❤️ !

@adamziel adamziel merged commit cf51f27 into trunk Apr 15, 2024
@adamziel adamziel changed the title Blueprints Crash Course Blueprints 101 guide Apr 15, 2024
@adamziel
Copy link
Contributor Author

I’m curious to hear more about the “Community Space”. Is there discussion already around where and what this might look like? 🤔
Would it be a WP.org forum? A developer.wordpress.org area? Or something else?

@colorful-tones it would be this repository :-) We'd have to transfer it to the WordPress organization first, of course. See the main readme at https://github.com/adamziel/blueprints

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation v1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Blueprints developer documentation
5 participants