WordPress / WordPress/php-toolkit
Blueprints onboarding documentation
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 61
- Forks
- 21
- Avg merge
- 19h 34m
- Merged PRs (30d)
- 7
Description
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
- How to install a plugin or a theme....
- 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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the proposed Blueprint documentation outline, including the first Blueprint, setup basics, intermediate topics, advanced examples, and getting help. Start by identifying which topics are missing and which documents should be prioritized. Done means an agreed documentation plan with clear priorities, rather than implementing every item in the outline.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json, php, wordpress
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100