Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Blueprints onboarding documentation

Đang mở
  • Có gì không ổn?
#64 2 bình luận 2 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
json, php, wordpress
Lĩnh vực
documentation

Hướng nghiên cứu

Rà soát dàn ý tài liệu Blueprint được đề xuất, bao gồm Blueprint đầu tiên, các kiến thức cơ bản về thiết lập, các chủ đề trung cấp, các ví dụ nâng cao và cách nhận trợ giúp. Bắt đầu bằng việc xác định những chủ đề còn thiếu và những tài liệu nào nên được ưu tiên. Hoàn thành có nghĩa là đạt được một kế hoạch tài liệu đã được thống nhất với các mức độ ưu tiên rõ ràng, thay vì triển khai mọi mục trong dàn ý.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation V1

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

Ngôn ngữ chính
PHP
Star
62
Fork
23
Merge trung bình
4 giờ 12 phút
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của WordPress/php-toolkit

Tất cả issue của WordPress/php-toolkit

Issue tương tự

Thêm issue về PHP

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.