You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 <[email protected]>
Co-authored-by: Birgit Pauli-Haack <[email protected]>
We encourage you to contribute your own Blueprints to this repository!
4
4
5
-
### Building your first Blueprint
5
+
##Build your first Blueprint
6
6
7
-
See [Building your first Blueprint](./docs/how-to-build-a-blueprint/your-first-blueprint.md).
7
+
Not sure how? Check out the [Blueprints 101](./docs/index.md).
8
8
9
-
### Submitting your Blueprint to this repository
9
+
##Submit your Blueprint to this repository
10
10
11
-
To keep the submission process smooth, please follow the following guidelines:
11
+
To keep the submission process smooth, please follow these guidelines:
12
12
13
-
Submit your Blueprint as a Pull Request to this repository.
13
+
1. Submit [a Pull Request (PR)](https://github.com/adamziel/blueprints/pulls) with your Blueprint.
14
+
2. The PR must contain a single `blueprint.json` file under the path `blueprints/your-blueprint-name/blueprint.json` (like [the examples here](https://github.com/adamziel/blueprints/tree/trunk/blueprints)).
15
+
3. Include all static files (WXR, ZIP, JPG, etc.) listed in the Blueprint in the submitted directory of your PR, and reference them via the `https://raw.githubusercontent.com` domain.
16
+
4. By submitting a Blueprint, you agree to license it under [GPLv2 or later license](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html).
14
17
15
-
Your Pull Request must contain a single `blueprint.json` file under a path `blueprints/your-blueprint-name/blueprint.json`.
18
+
## Blueprint metadata
16
19
17
-
All static files (WXR, ZIP, JPG etc.) referenced by the Blueprint must be included in the submitted directory in your Pull Request and referenced via the `raw.githubusercontent.com` domain.
20
+
Each Blueprint should include metadata within the top-level "meta" key of the `blueprint.json` file.
18
21
19
-
By submitting a Blueprint, you agree to license it under GPLv2 or later license.
22
+
Here's what's required:
20
23
21
-
### Blueprint Metadata
24
+
-**Title:** a clear and concise name for your Blueprint.
25
+
-**Author:** your GitHub username, to let others know who created the Blueprint.
22
26
23
-
Each Blueprint should include some basic metadata within the top-level "meta" key in the blueprint.json file. Here's what's required:
27
+
Optionally, you can add:
24
28
25
-
* Title: A clear and concise name for your Blueprint.
26
-
* Author (GitHub Username): Let others know who created the Blueprint.
27
-
28
-
Optionally, you can also include:
29
-
30
-
* Description: Provide a brief explanation of what your Blueprint offers.
31
-
* Categories: Specify relevant categories to help users find your Blueprint in the future Blueprints section on WordPress.org.
29
+
-**Description:** a brief explanation of what the Blueprint offers.
30
+
-**Categories:** specify relevant categories to help users find your Blueprint in the future Blueprints section on WordPress.org.
32
31
33
32
Here's an example:
34
33
@@ -43,6 +42,6 @@ Here's an example:
43
42
}
44
43
```
45
44
46
-
### Needing Help?
45
+
##Need help?
47
46
48
-
If you have questions or need assistance, start a new issue in this repository.
47
+
If you have questions or comments, [open a new issue](https://github.com/adamziel/blueprints/issues) in this repository.
Copy file name to clipboardexpand all lines: GALLERY.md
+3-1
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
1
# WordPress Blueprints Gallery
2
2
3
-
Here's the list of all the community Blueprints submitted to this repository. See the [contribution guidelines](./README.md#contributing-your-blueprint) to submit your Blueprint and share your WordPress setup with the world!
3
+
Here are all the community Blueprints submitted to this repository.
4
+
5
+
Want to share your WordPress setup with the world? See the [contribution guidelines](./CONTRIBUTING.md) for more information on how to submit your Blueprint.
Copy file name to clipboardexpand all lines: README.md
+20-14
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,11 @@
5
5
6
6
## What are Blueprints?
7
7
8
-
Blueprints are WordPress setup descriptions that can be previewed live in [WordPress Playground](https://w.org/playground). Just like this one:
8
+
Check out [Blueprints 101](./docs/index.md) to get started.
9
+
10
+
Here's a quick overview:
11
+
12
+
Blueprints are WordPress setup scripts that you can preview live in [WordPress Playground](https://w.org/playground). Here's a simple example:
9
13
10
14
```json
11
15
{
@@ -17,31 +21,33 @@ Blueprints are WordPress setup descriptions that can be previewed live in [WordP
17
21
18
22
[<kbd> <br> Preview in WordPress Playground <br> </kbd>](https://playground.wordpress.net/#%7B%22plugins%22:%5B%22hello-dolly%22,%22gutenberg%22%5D,%20%22login%22:%20true,%20%22landingPage%22:%20%22/wp-admin/plugins.php%22%20%7D)
19
23
20
-
Blueprints contain all the setup information including plugins, themes, site options, starter content to import, and more. See [Building your first Blueprint](./docs/how-to-build-a-blueprint/your-first-blueprint.md) for more details.
24
+
Blueprints contain all the installation instructions needed to setup WordPress, including plugins, themes, site options, starter content to import, and more.
25
+
26
+
Check out [Blueprints 101](./docs/index.md) to get started with Blueprints.
21
27
22
28
## Why use Blueprints?
23
29
24
-
Blueprints can help you:
30
+
Blueprints can help you
25
31
26
-
*Explore different setups – Try out different themes and plugins without the risk of breaking your site. It's a safe environment to see what works best for your needs.
27
-
*Save time – Instead of manually setting up your site, choosing themes, and installing plugins one by one, Blueprints do all that work for you in a few clicks.
28
-
*Learn WordPress – Blueprints are a fantastic way to play with a variety of WordPress configurations.
32
+
-**Explore different setups:** try out different themes and plugins without the risk of breaking your site. It's a safe environment to see what works best for your needs.
33
+
-**Save time**:** instead of manually setting up your site, choosing themes, and installing plugins one by one, Blueprints do all work for you.
34
+
-**Learn WordPress:** Blueprints are a fantastic way to play with a variety of WordPress configurations.
29
35
30
36
## Ready to jump in?
31
37
32
-
In this community space, you can:
38
+
This community space allows you to
33
39
34
-
*[Browse the Blueprints Gallery](./GALLERY.md)to explore a variety of WordPress sites.
35
-
*[Submit your own Blueprint](./CONTRIBUTING.md)to share your WordPress setup with the community.
40
+
*[Browse the Blueprints Gallery](./GALLERY.md)and explore diverse WordPress sites.
41
+
*[Submit your own Blueprint](./CONTRIBUTING.md)and share your WordPress setup with the community.
36
42
37
43
## Contributing your Blueprint
38
44
39
-
We encourage you to contribute your own Blueprints to this repository! New submissions are accepted as Pull Requests, for more details consult [Contributing Guidelines](./CONTRIBUTING.md)
45
+
We encourage you to contribute your Blueprints to this repository! We accepet new submissions as Pull Requests. Read the [Contributing Guidelines](./CONTRIBUTING.md) for more details.
40
46
41
-
## Needing Help?
47
+
## Need help?
42
48
43
-
If you have questions or need assistance, start a new issue in this repository.
49
+
If you have questions or comments, [open a new issue](https://github.com/adamziel/blueprints/issues) in this repository.
44
50
45
-
## Let's Build the Blueprint Community Together!
51
+
## Let's build the Blueprint Community together!
46
52
47
-
This is a minimal version 1 (v1) to get the community space up and running quickly. We plan to build upon this foundation based on your feedback. So, explore, create, and share your Blueprints!
53
+
This is a minimal version 1 (v1) to get the community space up and running. We plan to build upon this foundation, expand, and improve it—with your feedback. So, explore, create, and share your Blueprints!
0 commit comments