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 crash course V2 #7

Merged

Conversation

ironnysh
Copy link
Collaborator

@ironnysh ironnysh commented Apr 6, 2024

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 :-)

@ironnysh
Copy link
Collaborator Author

ironnysh commented Apr 7, 2024

Forgot something important: are the shorthands documented somewhere?

@adamziel
Copy link
Contributor

adamziel commented Apr 8, 2024

This is fantastic @ironnysh, thank you so much! I really like how you condensed the number of pages while keeping the structure clean ❤️

Forgot something important: are the shorthands documented somewhere?

They aren't at the moment, I've added them as an experimental feature a few months ago and didn't want to spread them too much in case I'd have to remove them later on. Today I'm quite certain they're here to stay which also means there are no more blockers to documenting them.

@adamziel adamziel merged commit 9c35f5b into WordPress:blueprints-crash-course Apr 8, 2024
@ironnysh
Copy link
Collaborator Author

Thanks, @adamziel, always a pleasure! 😃

there are no more blockers to documenting them.

Coolio, let's do it. Is there a list somewhere (I can also "extract" these from a typescript file, if you'll point me to it)?

@adamziel
Copy link
Contributor

@ironnysh it's here:

https://github.com/WordPress/wordpress-playground/blob/d135cafc10d0e2e624c0ecd47e24b1ac4be4cec0/packages/playground/blueprints/src/lib/compile.ts#L100-L146

For now those are:

  • constants ({"constants": { "const_a": "value", "const_b": "value" } })
  • siteOptions ({"siteOptions": { "blogname": "My blog!" } })
  • plugins ({"plugins": [ "gutenberg", { "resource": "url", "url": "..." } ] })
  • login ({"login": true} or {"login": { "username": "admin", "password": "password" } }

@ironnysh
Copy link
Collaborator Author

Perfect, thanks!

I think the Steps page would be the natural place for these, right?

I can open a new issue for this on the main repo, or is there another process for documentation now?

@adamziel
Copy link
Contributor

Sounds great @ironnysh, thank you! A PR for the main repo would be the right way for now until we can figure out a Playground-based workflow.

ironnysh added a commit to WordPress/wordpress-playground that referenced this pull request Apr 16, 2024
adamziel added a commit to WordPress/wordpress-playground that referenced this pull request Apr 16, 2024
)

Adds documentation for `shorthand` variations of Blueprint `steps`.
([See context and discussion
here](WordPress/blueprints#7 (comment))).

The new section covers the following:
- briefly explains what are `shorthands`
- lists supported steps (with code examples)
- describes when should people use each alternative.

---------

Co-authored-by: Adam Zielinski <adam@adamziel.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants